The in-memory representation of an ECProperty as defined by ECSchemaXML. More...
#include <ECSchema.h>
Public Member Functions | |
| bool | IsCalculated () const |
| Returns true if this ECProperty has a CalculatedECPropertySpecification custom attribute applied to it. More... | |
| bool | SetCalculatedPropertySpecification (IECInstanceP expressionAttribute) |
| Sets or removes the CalculatedECPropertySpecification custom attribute associated with this ECProperty. More... | |
| ECPropertyId | GetId () const |
| Return unique id (May return 0 until it has been explicitly set by ECDb or a similar system) More... | |
| ECClassCR | GetClass () const |
| Returns the name of the ECClass that this property is contained within. More... | |
| WStringCR | GetName () const |
| Gets the name of the ECProperty. More... | |
| bool | GetIsDisplayLabelDefined () const |
| Returns whether the DisplayLabel is explicitly set. More... | |
| bool | GetIsStruct () const |
| Returns whether this property is a Struct property. More... | |
| bool | GetIsArray () const |
| Returns whether this property is an Array property. More... | |
| bool | GetIsPrimitive () const |
| Returns whether this property is a Primitive property. More... | |
| ECObjectsStatus | SetTypeName (WString value) |
| Sets the ECXML typename for the property. More... | |
| WString | GetTypeName () const |
| The ECXML typename for the property. More... | |
| ECObjectsStatus | SetDescription (WStringCR value) |
| Sets the description for this ECProperty. More... | |
| WStringCR | GetDescription () const |
| The Description of this ECProperty. Returns the localized description if one exists. More... | |
| WStringCR | GetInvariantDescription () const |
| Gets the invariant description for this ECProperty. More... | |
| ECObjectsStatus | SetDisplayLabel (WStringCR value) |
| Sets the Display Label for this ECProperty. More... | |
| WStringCR | GetDisplayLabel () const |
| Gets the Display Label for this ECProperty. If no label has been set explicitly, it will return the Name of the property. More... | |
| WStringCR | GetInvariantDisplayLabel () const |
| Gets the invariant display label for this ECSchema. More... | |
| ECObjectsStatus | SetIsReadOnly (bool value) |
| Sets whether this ECProperty's value is read only. More... | |
| bool | GetIsReadOnly () const |
| Gets whether this ECProperty's value is read only. More... | |
| ECObjectsStatus | SetBaseProperty (ECPropertyCP value) |
| Sets the base property that this ECProperty inherits from. More... | |
| ECPropertyCP | GetBaseProperty () const |
| Gets the base property, if any, that this ECProperty inherits from. More... | |
| ECObjectsStatus | SetIsReadOnly (WCharCP isReadOnly) |
| Sets whether this ECProperty's value is read only. More... | |
| PrimitiveECPropertyCP | GetAsPrimitiveProperty () const |
| Returns the property as a const PrimitiveECProperty*. More... | |
| PrimitiveECPropertyP | GetAsPrimitivePropertyP () |
| Returns the property as a PrimitiveECProperty*. More... | |
| ArrayECPropertyCP | GetAsArrayProperty () const |
| Returns the property as a const ArrayECProperty*. More... | |
| ArrayECPropertyP | GetAsArrayPropertyP () |
| Returns the property as an ArrayECProperty*. More... | |
| StructECPropertyCP | GetAsStructProperty () const |
| Returns the property as a const StructECProperty*. More... | |
| StructECPropertyP | GetAsStructPropertyP () |
| Returns the property as a StructECProperty*. More... | |
 Public Member Functions inherited from IECCustomAttributeContainer | |
| bool | IsDefined (WStringCR schemaName, WStringCR className) const |
| Returns true if the container has a custom attribute of a class of the specified name. More... | |
| bool | IsDefined (ECClassCR classDefinition) const |
| Returns true if the container has a custom attribute of a class of the specified class definition. More... | |
| IECInstancePtr | GetCustomAttribute (WStringCR schemaName, WStringCR className) const |
| Retrieves the custom attribute matching the class name. More... | |
| IECInstancePtr | GetCustomAttribute (ECClassCR classDefinition) const |
| Retrieves the custom attribute matching the class definition. More... | |
| IECInstancePtr | GetCustomAttributeLocal (WStringCR schemaName, WStringCR className) const |
| Retrieves the custom attribute matching the class name. More... | |
| IECInstancePtr | GetCustomAttributeLocal (ECClassCR classDefinition) const |
| Retrieves the custom attribute matching the class definition. More... | |
| IECInstancePtr | GetPrimaryCustomAttribute (WStringCR schemaName, WStringCR className) const |
| Retrieves the custom attribute matching the class name. More... | |
| IECInstancePtr | GetPrimaryCustomAttribute (ECClassCR classDefinition) const |
| Retrieves the custom attribute matching the class definition. More... | |
| ECCustomAttributeInstanceIterable | GetCustomAttributes (bool includeBase) const |
| Retrieves all custom attributes from the container including supplemental custom attributes. More... | |
| ECCustomAttributeInstanceIterable | GetPrimaryCustomAttributes (bool includeBase) const |
| Retrieves all custom attributes from the container NOT including supplemental custom attributes. More... | |
| ECObjectsStatus | SetCustomAttribute (IECInstanceR customAttributeInstance) |
| Adds a custom attribute to the container. More... | |
| bool | RemoveCustomAttribute (WStringCR schemaName, WStringCR className) |
| Removes a custom attribute from the container. More... | |
| bool | RemoveCustomAttribute (ECClassCR classDefinition) |
| Removes a custom attribute from the container. More... | |
| bool | IsDefined (WStringCR className) const |
| LEGECY METHODS. More... | |
| IECInstancePtr | GetCustomAttribute (WStringCR className) const |
| IECInstancePtr | GetCustomAttributeLocal (WStringCR className) const |
| IECInstancePtr | GetPrimaryCustomAttribute (WStringCR className) const |
| bool | RemoveCustomAttribute (WStringCR className) |
Detailed Description
The in-memory representation of an ECProperty as defined by ECSchemaXML.
Member Function Documentation
| ArrayECPropertyCP GetAsArrayProperty | ( | ) | const |
Returns the property as a const ArrayECProperty*.
| ArrayECPropertyP GetAsArrayPropertyP | ( | ) |
Returns the property as an ArrayECProperty*.
| PrimitiveECPropertyCP GetAsPrimitiveProperty | ( | ) | const |
Returns the property as a const PrimitiveECProperty*.
| PrimitiveECPropertyP GetAsPrimitivePropertyP | ( | ) |
Returns the property as a PrimitiveECProperty*.
| StructECPropertyCP GetAsStructProperty | ( | ) | const |
Returns the property as a const StructECProperty*.
| StructECPropertyP GetAsStructPropertyP | ( | ) |
Returns the property as a StructECProperty*.
| ECPropertyCP GetBaseProperty | ( | ) | const |
Gets the base property, if any, that this ECProperty inherits from.
| ECClassCR GetClass | ( | ) | const |
Returns the name of the ECClass that this property is contained within.
| WStringCR GetDescription | ( | ) | const |
The Description of this ECProperty. Returns the localized description if one exists.
| WStringCR GetDisplayLabel | ( | ) | const |
Gets the Display Label for this ECProperty. If no label has been set explicitly, it will return the Name of the property.
| ECPropertyId GetId | ( | ) | const |
Return unique id (May return 0 until it has been explicitly set by ECDb or a similar system)
| WStringCR GetInvariantDescription | ( | ) | const |
Gets the invariant description for this ECProperty.
| bool GetIsArray | ( | ) | const |
Returns whether this property is an Array property.
| bool GetIsDisplayLabelDefined | ( | ) | const |
Returns whether the DisplayLabel is explicitly set.
| bool GetIsPrimitive | ( | ) | const |
Returns whether this property is a Primitive property.
| bool GetIsReadOnly | ( | ) | const |
Gets whether this ECProperty's value is read only.
| bool GetIsStruct | ( | ) | const |
Returns whether this property is a Struct property.
| WStringCR GetName | ( | ) | const |
Gets the name of the ECProperty.
| WString GetTypeName | ( | ) | const |
The ECXML typename for the property.
The TypeName for struct properties will be the ECClass name of the struct. It may be qualified with a namespacePrefix if the struct belongs to a schema that is referenced by the schema actually containing this property. The TypeName for array properties will be the type of the elements the array contains. This method returns a wstring by value because it may be a computed string. For instance struct properties may return a qualified typename with a namespace prefix relative to the containing schema.
| bool IsCalculated | ( | ) | const |
Returns true if this ECProperty has a CalculatedECPropertySpecification custom attribute applied to it.
| ECObjectsStatus SetBaseProperty | ( | ECPropertyCP | value | ) |
Sets the base property that this ECProperty inherits from.
| bool SetCalculatedPropertySpecification | ( | IECInstanceP | expressionAttribute | ) |
Sets or removes the CalculatedECPropertySpecification custom attribute associated with this ECProperty.
- Parameters
-
[in] expressionAttribute An IECInstance of the ECClass CalculatedECPropertySpecification, or NULL to remove the specification.
- Returns
- true if the specification was successfully updated.
- Remarks
- Call this method rather than setting the custom attribute directly, to ensure internal state is updated.
| ECObjectsStatus SetDescription | ( | WStringCR | value | ) |
Sets the description for this ECProperty.
| ECObjectsStatus SetDisplayLabel | ( | WStringCR | value | ) |
Sets the Display Label for this ECProperty.
| ECObjectsStatus SetIsReadOnly | ( | bool | value | ) |
Sets whether this ECProperty's value is read only.
| ECObjectsStatus SetIsReadOnly | ( | WCharCP | isReadOnly | ) |
Sets whether this ECProperty's value is read only.
| ECObjectsStatus SetTypeName | ( | WString | value | ) |
Sets the ECXML typename for the property.
- See also
- GetTypeName()
The documentation for this struct was generated from the following file: