ACAPI_​Element_​IsPropertyDefinitionValueEditableDefault

Tells whether the value of the property can be modified for the specified tool default.

    bool  ACAPI_Element_IsPropertyDefinitionValueEditableDefault (
        API_ElemTypeID          typeID,
        API_ElemVariationID     variationID,
        const API_Guid&         propertyGuid
    );

 

Parameters

typeID
[in] Type of the default element.
variationID
[in] The element variation that distinguishes the element kinds of the same type.
propertyGuid
[in] The property definition GUID to search for.

 

Return Values

true
The value of the property can be modified.
false
The value of the property can not be modified. For example, it is a read-only property, or a User Defined property with expression, which has cyclic property references.

Example


GSErrCode GetAvailablePropertyDefinitions (API_ElemTypeID typeId, API_ElemVariationID variationID, GS::Array<API_PropertyDefinition>& editableProperties)
{
	GS::Array<API_PropertyDefinition> definitions;
	GSErrCode error = ACAPI_Element_GetPropertyDefinitionsOfDefaultElem (typeId, variationID, API_PropertyDefinitionFilter_UserDefined, definitions);
	if (error == NoError) {
		for (UInt32 i = 0; i < definitions.GetSize (); ++i) {
			if (ACAPI_Element_IsPropertyDefinitionValueEditableDefault (typeId, variationID, definitions[i].guid)) {
				editableProperties.Push (definitions[i]);
			}
		}
	}
	return error;
}
        

 

Requirements

Version: API 22 or later
Header: ACAPinc.h

 

See Also

Properties,
API Functions