ACAPI_​Element_​IsPropertyDefinitionVisibleDefault

Tells whether a property definition is visible for an element default.

    bool  ACAPI_Element_IsPropertyDefinitionVisibleDefault (
        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 given property definition is visible for the element default.
false
The given property definition is not visible for the element default.

Example


GSErrCode GetVisiblePropertyDefinitions (API_ElemTypeID typeId, API_ElemVariationID variationID, GS::Array<API_PropertyDefinition>& visibleProperties)
{
    GS::Array<API_PropertyDefinition> definitions;
    GSErrCode error = ACAPI_Property_GetPropertyDefinitions (APINULLGuid, definitions);
    if (error == NoError) {
        for (UInt32 i = 0; i < definitions.GetSize (); ++i) {
            if (ACAPI_Element_IsPropertyDefinitionVisibleDefault (typeId, variationID, definitions[i].guid)) {
                visibleProperties.Push (definitions[i]);
            }
        }
    }
    return error;
}
        
For more detailed examples, please see the Property_Test add-on.

 

Requirements

Version: API 21 or later
Header: ACAPinc.h

 

See Also

Properties, Classification and Property Visibility