Archicad 27 C++ API
|
Functions related to accessing and manipulating Properties and the category-related data of elements and attributes. More...
Classes | |
struct | API_Variant |
A container that can store different types of data. More... | |
struct | API_SingleVariant |
A container for storing a single value. More... | |
struct | API_ListVariant |
A container for storing a list of values. More... | |
struct | API_SingleEnumerationVariant |
A container for storing a single value from a list of allowed values. More... | |
struct | API_PropertyValue |
A container for storing a property's value. More... | |
struct | API_PropertyDefaultValue |
A structure representing a property default value. More... | |
struct | API_PropertyGroup |
A structure representing a property group. More... | |
struct | API_PropertyDefinition |
A structure representing a property definition. More... | |
struct | API_Property |
A container that can store different types of data. More... | |
class | API_PropertyConversionUtilsInterface |
Typedefs | |
typedef GSErrCode __ACENV_CALL | APIPropertyObjectCommandProc(API_PropertyObjectParams *propertyParams) |
Callback function to handle the different property assignments. | |
typedef bool __ACENV_CALL | APIPropertyVisibilityHandlerProc(API_PropertyVisibilityMode visibilityMode, const GS::Array< API_Guid > &classificationGuids, const API_Guid &propertyDefinitionGuid) |
Callback function to handle the visibility of a property. | |
Enumerations | |
enum | API_VariantStatus { API_VariantStatusNull , API_VariantStatusUserUndefined , API_VariantStatusNormal } |
Describes the status of a variant value. | |
Functions | |
GSErrCode __ACENV_CALL | ACAPI_Property_CheckPropertyExpressionString (GS::UniString *expressionString) |
Checks if the given property expression is a syntactically valid one. | |
GSErrCode __ACENV_CALL | ACAPI_Property_GetPropertyExprReferenceString (API_PropertyDefinition *propertyDefinition, GS::UniString *propertyReferenceString) |
Returns the string that can be used in expressions to refer to a specific property. | |
GSErrCode __ACENV_CALL | ACAPI_Property_RegisterPropertyObjectHandler (short assignStrResID) |
Registers a property handler. | |
GSErrCode __ACENV_CALL | ACAPI_Property_RegisterPropertyVisibilityHandler (void) |
Tells Archicad that your add-on wants to modify property visibility. | |
GSErrCode __ACENV_CALL | ACAPI_Property_InstallPropertyObjectHandler (short strResID, APIPropertyObjectCommandProc *propertyCommandProc) |
Installs the property handler function for the given menu item. | |
GSErrCode __ACENV_CALL | ACAPI_Property_InstallPropertyVisibilityHandler (APIPropertyVisibilityHandlerProc *handlerProc) |
Installs the property visibility handler function. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetPropertyObjects (const API_Elem_Head *elemHead, API_PropertyObjectRefType ***propRefs, Int32 *nProp) |
Returns property objects of the element. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetPropertyDefinitions (const API_Guid &elemGuid, API_PropertyDefinitionFilter filter, GS::Array< API_PropertyDefinition > &propertyDefinitions) |
Retrieves all of the property definitions that are available for an element. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetPropertyValue (const API_Guid &elemGuid, const API_Guid &propertyDefinitionGuid, API_Property &property) |
Retrieves the specified property definition's value from the element. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetPropertyValues (const API_Guid &elemGuid, const GS::Array< API_PropertyDefinition > &propertyDefinitions, GS::Array< API_Property > &properties) |
Retrieves the specified property definitions with values. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetPropertyValuesByGuid (const API_Guid &elemGuid, const GS::Array< API_Guid > &propertyDefinitions, GS::Array< API_Property > &properties) |
Retrieves the specified property definitions (defined by their GUIDs) with values. | |
GSErrCode __ACENV_CALL | ACAPI_Element_SetProperty (const API_Guid &elemGuid, const API_Property &property) |
Sets the specified property for the given values on an element. | |
GSErrCode __ACENV_CALL | ACAPI_Element_SetProperties (const API_Guid &elemGuid, const GS::Array< API_Property > &properties) |
Sets the specified properties for the given values on an element. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetPropertyDefinitionsOfDefaultElem (const API_ElemType &type, API_PropertyDefinitionFilter filter, GS::Array< API_PropertyDefinition > &definitions) |
Retrieves all of the property definitions that are available for an element default. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetPropertyValueOfDefaultElem (const API_ElemType &type, const API_Guid &propertyDefinitionGuid, API_Property &property) |
Retrieves the value of the specified property definition. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetPropertyValuesOfDefaultElem (const API_ElemType &type, const GS::Array< API_PropertyDefinition > &propertyDefinitions, GS::Array< API_Property > &properties) |
Retrieves the values of the specified property definitions. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetPropertyValuesOfDefaultElemByGuid (const API_ElemType &type, const GS::Array< API_Guid > &propertyDefinitionGuids, GS::Array< API_Property > &properties) |
Retrieves the values of the specified property definitions. | |
GSErrCode __ACENV_CALL | ACAPI_Element_SetPropertyOfDefaultElem (const API_ElemType &type, const API_Property &property) |
Sets the specified property to the given value on an element default. | |
GSErrCode __ACENV_CALL | ACAPI_Element_SetPropertiesOfDefaultElem (const API_ElemType &type, const GS::Array< API_Property > &properties) |
Sets the specified properties for the given values on an element default. | |
bool __ACENV_CALL | ACAPI_Element_IsPropertyDefinitionValueEditable (const API_Guid &elemGuid, const API_Guid &propertyGuid) |
Tells whether the value of the property can be modified for the specified element. If the elemGuid argument is APINULLGuid, it tells whether the property definition's default value is editable. | |
bool __ACENV_CALL | ACAPI_Element_IsPropertyDefinitionValueEditableDefault (const API_ElemType &type, const API_Guid &propertyGuid) |
Tells whether the value of the property can be modified for the specified tool default. | |
bool __ACENV_CALL | ACAPI_Element_IsPropertyDefinitionAvailable (const API_Guid &elemGuid, const API_Guid &propertyGuid) |
Tells whether a property definition is available for an element. | |
bool __ACENV_CALL | ACAPI_Element_IsPropertyDefinitionAvailableDefault (const API_ElemType &type, const API_Guid &propertyGuid) |
Tells whether a property definition is available for an element default. | |
bool __ACENV_CALL | ACAPI_Element_IsPropertyDefinitionVisible (const API_Guid &elemGuid, const API_Guid &propertyGuid) |
Tells whether a property definition is visible for an element. | |
bool __ACENV_CALL | ACAPI_Element_IsPropertyDefinitionVisibleDefault (const API_ElemType &type, const API_Guid &propertyGuid) |
Tells whether a property definition is visible for an element default. | |
GSErrCode __ACENV_CALL | ACAPI_Property_AddProperty (API_PropertyDefinition &definition, const GS::Array< API_Guid > &elemGuids) |
Makes a property definition available for all of given elements (it is created if it does not exist). | |
GSErrCode __ACENV_CALL | ACAPI_Property_ModifyPropertyValue (const API_Property &property, const GS::Array< API_Guid > &elemGuids) |
Sets the value of a property for multiple elements. If the property is not available for at least one of the given element then returns with an error without changing any property value. | |
GSErrCode __ACENV_CALL | ACAPI_Property_DeleteProperty (const API_Guid &definitionGuid, const GS::Array< API_Guid > &elemGuids) |
Makes a property definition unavailable for all of given elements. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetPropertyDefinitions (const API_ElemComponentID &elemComponent, API_PropertyDefinitionFilter filter, GS::Array< API_PropertyDefinition > &propertyDefinitions) |
Retrieves all of the property definitions that are available for a component of an element. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetPropertyValue (const API_ElemComponentID &elemComponent, const API_Guid &propertyDefinitionGuid, API_Property &property) |
Retrieves the specified property definition's value from the component. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetPropertyValues (const API_ElemComponentID &elemComponent, const GS::Array< API_PropertyDefinition > &propertyDefinitions, GS::Array< API_Property > &properties) |
Retrieves the values of the specified property definitions from the component. | |
GSErrCode __ACENV_CALL | ACAPI_Element_GetPropertyValuesByGuid (const API_ElemComponentID &elemComponent, const GS::Array< API_Guid > &propertyDefinitions, GS::Array< API_Property > &properties) |
Retrieves the specified property definitions (defined by their GUIDs) with values from the component. | |
GSErrCode __ACENV_CALL | ACAPI_Notification_PropertyVisibilityChanged () |
Sends out an APINotify_PropertyVisibilityChanged project event notification to the other add-ons to state that at least one property's visibility has changed. | |
GSErrCode __ACENV_CALL | ACAPI_ActivatePropertyObjectHandler (short strResID, bool active) |
Activates or deactivates an add-on's property handler. | |
GSErrCode __ACENV_CALL | ACAPI_Property_GetPropertyGroups (GS::Array< API_PropertyGroup > &groups) |
Retrieves all the property groups. | |
GSErrCode __ACENV_CALL | ACAPI_Property_GetPropertyDefinitions (const API_Guid &groupGuid, GS::Array< API_PropertyDefinition > &definitions) |
Retrieves all the property definitions from a given group. | |
GSErrCode __ACENV_CALL | ACAPI_Property_GetPropertyGroup (API_PropertyGroup &group) |
Retrieves one property group identified by its guid. | |
GSErrCode __ACENV_CALL | ACAPI_Property_GetPropertyDefinition (API_PropertyDefinition &definition) |
Retrieves one property definition identified by its guid. | |
GSErrCode __ACENV_CALL | ACAPI_Property_CreatePropertyGroup (API_PropertyGroup &group) |
Creates a property group in the current plan. | |
GSErrCode __ACENV_CALL | ACAPI_Property_CreatePropertyDefinition (API_PropertyDefinition &definition) |
Creates a property definition in the current plan. | |
GSErrCode __ACENV_CALL | ACAPI_Property_ChangePropertyGroup (const API_PropertyGroup &group) |
Changes an already existing property group in the current plan (identified by its guid). | |
GSErrCode __ACENV_CALL | ACAPI_Property_ChangePropertyDefinition (const API_PropertyDefinition &definition) |
Changes an already existing property definition in the current plan (identified by its guid). | |
bool __ACENV_CALL | ACAPI_Property_IsValidValue (const API_PropertyValue &value, const API_PropertyDefinition &definition) |
Returns true if the value is acceptable for the given property definition. | |
GSErrCode __ACENV_CALL | ACAPI_Property_DeletePropertyGroup (const API_Guid &groupGuid) |
Deletes a property group and all of the property definitions inside in the current plan. | |
GSErrCode __ACENV_CALL | ACAPI_Property_DeletePropertyDefinition (const API_Guid &propertyGuid) |
Deletes a property definition in the current plan. | |
GSErrCode __ACENV_CALL | ACAPI_Property_Import (const GS::UniString &propertyXml, API_PropertyDefinitionNameConflictResolutionPolicy conflictPolicy) |
Imports a property xml. | |
GSErrCode __ACENV_CALL | ACAPI_Property_GetPropertyValueString (const API_Property &apiProperty, GS::UniString *resultString) |
Convert an API property value to display string. | |
GSErrCode __ACENV_CALL | ACAPI_Property_SetPropertyValueFromString (const GS::UniString &propertyValueString, const API_PropertyConversionUtilsInterface &conversionUtils, API_Property *property) |
Sets the value of a property value from a passed string. | |
Functions related to accessing and manipulating Properties and the category-related data of elements and attributes.
This feature of the Archicad allows one to store user-defined name-value pairs for Model elements. The keys (names) of the properties are represented with API_PropertyDefinition, that are stored per project, not per element. The definitions are part of a two-level deep tree structure. On the top level there are API_PropertyGroup, which are a collection of definitions with a unique name. The definitions' name also has to be unique within its group.
The definitions also have descriptions and they store the value type (e.g int, double) and collection type (e.g single value, list) of the data it can store. If a definition is made available for a classification, then all the elements in that classification will have that property - initially with a default value, that is part of the definition.
Properties can also have an enumerated collection type, which means that their values are limited to a finite number of predefined valid values. In this case these predefined values are part of the definition
Please refer to the functions below the header of a thematic group to get details on that topic.
The following functions let you manipulate API_PropertyGroup.
The following functions let you manipulate API_PropertyDefinition
The following functions let you manipulate API_PropertyDefinition attached to elements.
The following functions let you manipulate API_PropertyValue attached to elements.
The following functions let you to efficiently manipulate properties for a list of elements.
The following functions let you manipulate the properties of the attributes
typedef GSErrCode __ACENV_CALL APIPropertyObjectCommandProc(API_PropertyObjectParams *propertyParams) |
Callback function to handle the different property assignments.
propertyParams | [in] the parameters of the property assignment. |
typedef bool __ACENV_CALL APIPropertyVisibilityHandlerProc(API_PropertyVisibilityMode visibilityMode, const GS::Array< API_Guid > &classificationGuids, const API_Guid &propertyDefinitionGuid) |
Callback function to handle the visibility of a property.
visibilityMode | [in] specifies what should the callback function return. Has one of the following values:
| ||||||
classificationGuids | [in] the classification guids of the current element. | ||||||
propertyDefinitionGuid | [in] the guid of the current property. |
GSErrCode __ACENV_CALL ACAPI_ActivatePropertyObjectHandler | ( | short | strResID, |
bool | active | ||
) |
Activates or deactivates an add-on's property handler.
strResID | [in] tells for which property handler is this command issued |
active | [in] turns the property handler on/off |
GSErrCode __ACENV_CALL ACAPI_Element_GetPropertyDefinitions | ( | const API_ElemComponentID & | elemComponent, |
API_PropertyDefinitionFilter | filter, | ||
GS::Array< API_PropertyDefinition > & | propertyDefinitions | ||
) |
Retrieves all of the property definitions that are available for a component of an element.
elemComponent | [in] The identifier of the element's component to search for. |
filter | [in] Filter the list of property definitions (API_PropertyDefinitionFilter_UserDefined, API_PropertyDefinitionFilter_BuiltIn , API_PropertyDefinitionFilter_All ). |
propertyDefinitions | [out] Array of property definitions that are available for the given component. |
GSErrCode __ACENV_CALL ACAPI_Element_GetPropertyDefinitions | ( | const API_Guid & | elemGuid, |
API_PropertyDefinitionFilter | filter, | ||
GS::Array< API_PropertyDefinition > & | propertyDefinitions | ||
) |
Retrieves all of the property definitions that are available for an element.
elemGuid | [in] The element's identifier to search for. |
filter | [in] Filter the list of property definitions (API_PropertyDefinitionFilter_UserDefined, API_PropertyDefinitionFilter_FundamentalBuiltIn , API_PropertyDefinitionFilter_UserLevelBuiltIn , API_PropertyDefinitionFilter_All ). |
propertyDefinitions | [out] Array of property definitions that are available for a classification of the given element. |
GSErrCode __ACENV_CALL ACAPI_Element_GetPropertyDefinitionsOfDefaultElem | ( | const API_ElemType & | type, |
API_PropertyDefinitionFilter | filter, | ||
GS::Array< API_PropertyDefinition > & | definitions | ||
) |
Retrieves all of the property definitions that are available for an element default.
type | [in] Type of the default element. |
filter | [in] The property definition type to filter for. |
definitions | [out] Array of property definitions that are available for a classification of the given element default. |
GSErrCode __ACENV_CALL ACAPI_Element_GetPropertyObjects | ( | const API_Elem_Head * | elemHead, |
API_PropertyObjectRefType *** | propRefs, | ||
Int32 * | nProp | ||
) |
Returns property objects of the element.
elemHead | [in] The element to get the properties for. |
propRefs | [out] List of property objects. |
nProp | [out] Number of the property objects. |
GSErrCode __ACENV_CALL ACAPI_Element_GetPropertyValue | ( | const API_ElemComponentID & | elemComponent, |
const API_Guid & | propertyDefinitionGuid, | ||
API_Property & | property | ||
) |
Retrieves the specified property definition's value from the component.
elemComponent | [in] The identifier of the element's component to search for. |
propertyDefinitionGuid | [in] The property definition to get the values for. |
property | [out] The value of the requested property. |
GSErrCode __ACENV_CALL ACAPI_Element_GetPropertyValue | ( | const API_Guid & | elemGuid, |
const API_Guid & | propertyDefinitionGuid, | ||
API_Property & | property | ||
) |
Retrieves the specified property definition's value from the element.
elemGuid | [in] The element GUID to search for. |
propertyDefinitionGuid | [in] The property definition to get the values for. |
property | [out] The value of the requested property. |
GSErrCode __ACENV_CALL ACAPI_Element_GetPropertyValueOfDefaultElem | ( | const API_ElemType & | type, |
const API_Guid & | propertyDefinitionGuid, | ||
API_Property & | property | ||
) |
Retrieves the value of the specified property definition.
type | [in] Type of the default element. |
propertyDefinitionGuid | [in] The property definition's GUID to get the value for. |
property | [out] The value of the requested property. |
GSErrCode __ACENV_CALL ACAPI_Element_GetPropertyValues | ( | const API_ElemComponentID & | elemComponent, |
const GS::Array< API_PropertyDefinition > & | propertyDefinitions, | ||
GS::Array< API_Property > & | properties | ||
) |
Retrieves the values of the specified property definitions from the component.
elemComponent | [in] The identifier of the element's component to search for. |
propertyDefinitions | [in] The property definitions to get the values for. |
properties | [out] The definitions and values of the requested properties. |
GSErrCode __ACENV_CALL ACAPI_Element_GetPropertyValues | ( | const API_Guid & | elemGuid, |
const GS::Array< API_PropertyDefinition > & | propertyDefinitions, | ||
GS::Array< API_Property > & | properties | ||
) |
Retrieves the specified property definitions with values.
elemGuid | [in] The element GUID to search for. |
propertyDefinitions | [in] The property definitions to get the values for. They are identified through definition.guid. |
properties | [out] The definitions and values of the requested properties. |
GSErrCode __ACENV_CALL ACAPI_Element_GetPropertyValuesByGuid | ( | const API_ElemComponentID & | elemComponent, |
const GS::Array< API_Guid > & | propertyDefinitions, | ||
GS::Array< API_Property > & | properties | ||
) |
Retrieves the specified property definitions (defined by their GUIDs) with values from the component.
elemComponent | [in] The identifier of the element's component to search for. |
propertyDefinitions | [in] The property definition GUIDs to get the values for. |
properties | [out] The definitions and values of the requested properties. |
GSErrCode __ACENV_CALL ACAPI_Element_GetPropertyValuesByGuid | ( | const API_Guid & | elemGuid, |
const GS::Array< API_Guid > & | propertyDefinitions, | ||
GS::Array< API_Property > & | properties | ||
) |
Retrieves the specified property definitions (defined by their GUIDs) with values.
elemGuid | [in] The element GUID to search for. |
propertyDefinitions | [in] The property definition GUIDs to get the values for. |
properties | [out] The definitions and values of the requested properties. |
GSErrCode __ACENV_CALL ACAPI_Element_GetPropertyValuesOfDefaultElem | ( | const API_ElemType & | type, |
const GS::Array< API_PropertyDefinition > & | propertyDefinitions, | ||
GS::Array< API_Property > & | properties | ||
) |
Retrieves the values of the specified property definitions.
type | [in] Type of the default element. |
propertyDefinitions | [in] The property definitions (identified by definition.guid) to get the values for. |
properties | [out] The definitions and values of the requested properties. |
GSErrCode __ACENV_CALL ACAPI_Element_GetPropertyValuesOfDefaultElemByGuid | ( | const API_ElemType & | type, |
const GS::Array< API_Guid > & | propertyDefinitionGuids, | ||
GS::Array< API_Property > & | properties | ||
) |
Retrieves the values of the specified property definitions.
type | [in] Type of the default element. |
propertyDefinitionGuids | [in] The property definition GUIDs to get the values for. |
properties | [out] The definitions and values of the requested properties. |
bool __ACENV_CALL ACAPI_Element_IsPropertyDefinitionAvailable | ( | const API_Guid & | elemGuid, |
const API_Guid & | propertyGuid | ||
) |
Tells whether a property definition is available for an element.
elemGuid | [in] The element GUID to search for. |
propertyGuid | [in] The property definition GUID to search for. |
bool __ACENV_CALL ACAPI_Element_IsPropertyDefinitionAvailableDefault | ( | const API_ElemType & | type, |
const API_Guid & | propertyGuid | ||
) |
Tells whether a property definition is available for an element default.
type | [in] Type of the default element. |
propertyGuid | [in] The property definition GUID to search for. |
bool __ACENV_CALL ACAPI_Element_IsPropertyDefinitionValueEditable | ( | const API_Guid & | elemGuid, |
const API_Guid & | propertyGuid | ||
) |
Tells whether the value of the property can be modified for the specified element. If the elemGuid argument is APINULLGuid, it tells whether the property definition's default value is editable.
elemGuid | [in] The element GUID to search for. It can be APINULLGuid, in this case the property definition's default value is checked. |
propertyGuid | [in] The property definition GUID to search for. |
bool __ACENV_CALL ACAPI_Element_IsPropertyDefinitionValueEditableDefault | ( | const API_ElemType & | type, |
const API_Guid & | propertyGuid | ||
) |
Tells whether the value of the property can be modified for the specified tool default.
type | [in] Type of the default element. |
propertyGuid | [in] The property definition GUID to search for. |
bool __ACENV_CALL ACAPI_Element_IsPropertyDefinitionVisible | ( | const API_Guid & | elemGuid, |
const API_Guid & | propertyGuid | ||
) |
Tells whether a property definition is visible for an element.
elemGuid | [in] The element GUID to search for. |
propertyGuid | [in] The property definition GUID to search for. |
bool __ACENV_CALL ACAPI_Element_IsPropertyDefinitionVisibleDefault | ( | const API_ElemType & | type, |
const API_Guid & | propertyGuid | ||
) |
Tells whether a property definition is visible for an element default.
type | [in] Type of the default element. |
propertyGuid | [in] The property definition GUID to search for. |
GSErrCode __ACENV_CALL ACAPI_Element_SetProperties | ( | const API_Guid & | elemGuid, |
const GS::Array< API_Property > & | properties | ||
) |
Sets the specified properties for the given values on an element.
elemGuid | [in] The element GUID to search for. |
properties | [in] Specifies the properties to be set. |
GSErrCode __ACENV_CALL ACAPI_Element_SetPropertiesOfDefaultElem | ( | const API_ElemType & | type, |
const GS::Array< API_Property > & | properties | ||
) |
Sets the specified properties for the given values on an element default.
type | [in] Type of the default element. |
properties | [in] Specifies the properties to be set. |
GSErrCode __ACENV_CALL ACAPI_Element_SetProperty | ( | const API_Guid & | elemGuid, |
const API_Property & | property | ||
) |
Sets the specified property for the given values on an element.
elemGuid | [in] The element GUID to search for. |
property | [in] Specifies the property to be set. |
GSErrCode __ACENV_CALL ACAPI_Element_SetPropertyOfDefaultElem | ( | const API_ElemType & | type, |
const API_Property & | property | ||
) |
Sets the specified property to the given value on an element default.
type | [in] Type of the default element. |
property | [in] Specifies the property to be set. |
GSErrCode __ACENV_CALL ACAPI_Notification_PropertyVisibilityChanged | ( | ) |
Sends out an APINotify_PropertyVisibilityChanged
project event notification to the other add-ons to state that at least one property's visibility has changed.
GSErrCode __ACENV_CALL ACAPI_Property_AddProperty | ( | API_PropertyDefinition & | definition, |
const GS::Array< API_Guid > & | elemGuids | ||
) |
Makes a property definition available for all of given elements (it is created if it does not exist).
definition | [in] The GUID of the definition (if already existing) or the data of the definition to create. [out] The GUID of the definition (if newly created) and the modified availability array. |
elemGuids | [in] The array of elements, that the property should be available for. |
GSErrCode __ACENV_CALL ACAPI_Property_ChangePropertyDefinition | ( | const API_PropertyDefinition & | definition | ) |
Changes an already existing property definition in the current plan (identified by its guid).
definition | [in] The property definition to change. |
GSErrCode __ACENV_CALL ACAPI_Property_ChangePropertyGroup | ( | const API_PropertyGroup & | group | ) |
Changes an already existing property group in the current plan (identified by its guid).
group | [in] The property group to change. |
GSErrCode __ACENV_CALL ACAPI_Property_CheckPropertyExpressionString | ( | GS::UniString * | expressionString | ) |
Checks if the given property expression is a syntactically valid one.
expressionString | [in] The expression whose validity is to be decided. |
GSErrCode __ACENV_CALL ACAPI_Property_CreatePropertyDefinition | ( | API_PropertyDefinition & | definition | ) |
Creates a property definition in the current plan.
definition | [in/out] The property definition to create. Once the operation completed successfully the guid field is overwritten with the id of the newly created property definition. |
GSErrCode __ACENV_CALL ACAPI_Property_CreatePropertyGroup | ( | API_PropertyGroup & | group | ) |
Creates a property group in the current plan.
group | [in/out] The property group to create. Once the operation completed successfully the guid field is overwritten with the id of the newly created property group. |
GSErrCode __ACENV_CALL ACAPI_Property_DeleteProperty | ( | const API_Guid & | definitionGuid, |
const GS::Array< API_Guid > & | elemGuids | ||
) |
Makes a property definition unavailable for all of given elements.
definitionGuid | [in] The GUID of the definition to remove from the elements. |
elemGuids | [in] The array of elements, that the property should not be available for. |
GSErrCode __ACENV_CALL ACAPI_Property_DeletePropertyDefinition | ( | const API_Guid & | propertyGuid | ) |
Deletes a property definition in the current plan.
propertyGuid | [in] The identifier of the property definition to delete. |
GSErrCode __ACENV_CALL ACAPI_Property_DeletePropertyGroup | ( | const API_Guid & | groupGuid | ) |
Deletes a property group and all of the property definitions inside in the current plan.
groupGuid | [in] The identifier of the property group to delete. |
GSErrCode __ACENV_CALL ACAPI_Property_GetPropertyDefinition | ( | API_PropertyDefinition & | definition | ) |
Retrieves one property definition identified by its guid.
definition | [in/out] The guid field specifies the property definition to retrieve. Once the operation completed successfully this will hold the retrieved property definition. |
GSErrCode __ACENV_CALL ACAPI_Property_GetPropertyDefinitions | ( | const API_Guid & | groupGuid, |
GS::Array< API_PropertyDefinition > & | definitions | ||
) |
Retrieves all the property definitions from a given group.
groupGuid | [out] The identifier of the group to search for or APINULLGuid if all property definitions should be retrieved. |
definitions | [out] The retrieved property definitions. |
GSErrCode __ACENV_CALL ACAPI_Property_GetPropertyExprReferenceString | ( | API_PropertyDefinition * | propertyDefinition, |
GS::UniString * | propertyReferenceString | ||
) |
Returns the string that can be used in expressions to refer to a specific property.
propertyDefinition | [in] The property definition to be refenced by the returned string. |
propertyReferenceString | [out] String for storing the returned property reference string. |
GSErrCode __ACENV_CALL ACAPI_Property_GetPropertyGroup | ( | API_PropertyGroup & | group | ) |
Retrieves one property group identified by its guid.
group | [in/out] The guid field specifies the property group to retrieve. Once the operation completed successfully this will hold the retrieved property group. |
GSErrCode __ACENV_CALL ACAPI_Property_GetPropertyGroups | ( | GS::Array< API_PropertyGroup > & | groups | ) |
Retrieves all the property groups.
groups | [out] The retrieved property groups. |
GSErrCode __ACENV_CALL ACAPI_Property_GetPropertyValueString | ( | const API_Property & | apiProperty, |
GS::UniString * | resultString | ||
) |
Convert an API property value to display string.
apiProperty | [in] An evaluated property with its value. |
resultString | [out] The string representation of the given property value. The function can resolve enumeration values (which are stored by the keyVariant in the apiProperty), as well as convert measured numeric values based on the current Project Preferences. |
GSErrCode __ACENV_CALL ACAPI_Property_Import | ( | const GS::UniString & | propertyXml, |
API_PropertyDefinitionNameConflictResolutionPolicy | conflictPolicy | ||
) |
Imports a property xml.
propertyXml | [in] The property xml to import. | ||||||||
conflictPolicy | [in] Specifies how to resolve name conflicts.
|
GSErrCode __ACENV_CALL ACAPI_Property_InstallPropertyObjectHandler | ( | short | strResID, |
APIPropertyObjectCommandProc * | propertyCommandProc | ||
) |
Installs the property handler function for the given menu item.
strResID | [in] The string resource ID you install the property handler for. |
propertyCommandProc | [in] The property command handler function. |
GSErrCode __ACENV_CALL ACAPI_Property_InstallPropertyVisibilityHandler | ( | APIPropertyVisibilityHandlerProc * | handlerProc | ) |
Installs the property visibility handler function.
handlerProc | [in] The property visibility handler function. |
bool __ACENV_CALL ACAPI_Property_IsValidValue | ( | const API_PropertyValue & | value, |
const API_PropertyDefinition & | definition | ||
) |
Returns true if the value is acceptable for the given property definition.
value | [in] The value to check. |
definition | [in] The valueType, collectionType and possibleEnumValues of the definition will be used to check the validity of the value. |
API_VariantStatusNormal
or API_VariantStatusUserUndefined
and value's variant.type is the same as definition's valueType. GSErrCode __ACENV_CALL ACAPI_Property_ModifyPropertyValue | ( | const API_Property & | property, |
const GS::Array< API_Guid > & | elemGuids | ||
) |
Sets the value of a property for multiple elements. If the property is not available for at least one of the given element then returns with an error without changing any property value.
property | [in] The new value of the property. |
elemGuids | [in] The array of elements, whose property should be changed. |
GSErrCode __ACENV_CALL ACAPI_Property_RegisterPropertyObjectHandler | ( | short | assignStrResID | ) |
Registers a property handler.
assignStrResID | [in] The string resource ID, which will be used in Archicad's dialogs. |
GSErrCode __ACENV_CALL ACAPI_Property_RegisterPropertyVisibilityHandler | ( | void | ) |
Tells Archicad that your add-on wants to modify property visibility.
GSErrCode __ACENV_CALL ACAPI_Property_SetPropertyValueFromString | ( | const GS::UniString & | propertyValueString, |
const API_PropertyConversionUtilsInterface & | conversionUtils, | ||
API_Property * | property | ||
) |
Sets the value of a property value from a passed string.
propertyValueString | [in] The string from which the new value will be generated. |
conversionUtils | [in] The implementation of API_PropertyConversionUtilsInterface. |
property | [in/out] The property whose value we want to set. |