A structure representing a property definition. More...

#include <APIdefs_Properties.h>

Public Attributes
API_PropertyDefinitionType	definitionType
	The type of this property definition:

API_Guid	guid
	The unique identifier of the property definition.

API_Guid	groupGuid
	The unique identifier of the property group that contains this definition.

GS::UniString	name
	The name of the property definition.

GS::UniString	description
	The description of the property definition.

API_PropertyCollectionType	collectionType
	The collection type of the property definition.

API_VariantType	valueType
	Type of the data that the property stores.

API_PropertyMeasureType	measureType
	Measure type of the data that the property stores. Measure types other than `API_PropertyDefaultMeasureType` (and `API_PropertyUndefinedMeasureType`) are only valid for properties which are of a single real type (collectionType is `API_PropertySingleCollectionType` and valueType is `API_PropertyRealValueType`).

API_PropertyDefaultValue	defaultValue
	The default value of this property definition.

GS::Array< API_Guid >	availability
	The list of classification GUIDs this property definition is available for.

GS::Array< API_SingleEnumerationVariant >	possibleEnumValues
	The list of available values in case of an enumeration value type.

bool	canValueBeEditable
	Specifies if the property values of this definition can possibly be edited. For custom properties it is always true, for built-ins, it might be false.

Detailed Description

A structure representing a property definition.

Remarks: In Archicad v2018 the defaultValue 's type has been changed to API_PropertyDefaultValue from API_PropertyValue.

Member Data Documentation

◆ collectionType

API_PropertyCollectionType API_PropertyDefinition::collectionType

The collection type of the property definition.

API_PropertyCollectionType	Meaning
API_PropertySingleCollectionType	The property stores a single value
API_PropertyListCollectionType	The property stores a list of values
API_PropertySingleChoiceEnumerationCollectionType	The property stores a single value from a list of allowed values
API_PropertyMultipleChoiceEnumerationCollectionType	The property stores a subset of values from a list of allowed values

◆ definitionType

API_PropertyDefinitionType API_PropertyDefinition::definitionType

The type of this property definition:

API_PropertyDefinitionType	Meaning
API_PropertyStaticBuiltInDefinitionType	It is a built-in property (the definition itself is read only). The set of static built-in properties do not change.
API_PropertyDynamicBuiltInDefinitionType	It is a built-in property (the definition itself is read only). The set of dynamic built-in properties may change as a result of Archicad operations.
API_PropertyCustomDefinitionType	It is a user-defined property definition (can be modified).

◆ measureType

API_PropertyMeasureType API_PropertyDefinition::measureType

Measure type of the data that the property stores. Measure types other than API_PropertyDefaultMeasureType (and API_PropertyUndefinedMeasureType) are only valid for properties which are of a single real type (collectionType is API_PropertySingleCollectionType and valueType is API_PropertyRealValueType).

API_PropertyMeasureType	Meaning
API_PropertyUndefinedMeasureType	The property is in invalid state.
API_PropertyDefaultMeasureType	The property doesn't have special measure.
Physical dimension measure types
API_PropertyLengthMeasureType	The property has length value.
API_PropertyAreaMeasureType	The property has area value.
API_PropertyVolumeMeasureType	The property has volume value.
API_PropertyAngleMeasureType	The property has angle value.
Index reference types (builtin properties only)
API_PropertyLineTypeIndexMeasureType	The property has line type attribute index value.
API_PropertyFillIndexMeasureType	The property has fill attribute index value.
API_PropertyCoverFillIndexMeasureType	The property has cover fill attribute index value.
API_PropertySurfaceIndexMeasureType	The property has surface attribute index value.
API_PropertyBuildingMaterialIndexMeasureType	The property has building material attribute index value.
API_PropertyCompositeMeasureType	The property has composite attribute index value.
API_PropertyProfileIndexMeasureType	The property has profile attribute index value.
API_PropertyLayerIndexMeasureType	The property has layer index value.
API_PropertyLayerCombinationIndexMeasureType	The property has layer combination index value.
API_PropertyRoomCategoryIndexMeasureType	The property has zone category index value.
API_PropertyMEPSystemIndexMeasureType	The property has MEP system index value.
API_PropertyPenSetIndexMeasureType	The property has pen set index value.
API_PropertyPenIndexMeasureType	The property has pen index value.
Font property types (builtin properties only)
API_PropertyFontIdMeasureType	The property has font id value.
API_PropertyTextLeadingMeasureType	The property has text leading value.
API_PropertyTextAlignmentMeasureType	The property has text alignment value.
API_PropertyFontStyleMeasureType	The property has font style value.
API_PropertyFontSizeMeasureType	The property has font size value.

◆ valueType

API_VariantType API_PropertyDefinition::valueType

Type of the data that the property stores.