Public Member Functions | List of all members
PropertyBindingSpec Struct Reference

Defines the dependent end of a property binding. More...

#include <ParametricModeling.h>

Public Member Functions

DGNPLATFORM_EXPORT PropertyBindingSpec (DgnElementECInstanceCR instance, WCharCP accessString)
 Constructor. More...
 
bool IsValid () const
 Returns true if the specification identifies a valid ECInstance. More...
 
WCharCP GetAccessString () const
 Returns the access string of the bound property. More...
 
DGNPLATFORM_EXPORT bool Schedule (EditElementHandleR eeh, WCharCP parameterAccessString) const
 Schedules a dependency on the active parameter with the specified access string. More...
 
DGNPLATFORM_EXPORT bool ScheduleRemoval (EditElementHandleR eeh) const
 Schedules the removal of the dependency defined by this specification. More...
 
DGNPLATFORM_EXPORT bool GetControllingParameterAccessString (WStringR accessString, ElementHandleCR eh) const
 Retrieves the access string of the active parameter to which the property represented by this specification is bound. More...
 
DGNPLATFORM_EXPORT bool HasControllingParameter (ElementHandleCR eh) const
 Returns true if the property represented by this specification on the specified element is bound to an active parameter. More...
 

Detailed Description

Defines the dependent end of a property binding.

Used for creating associations between ECProperties and ParameterDefinitions. Property binding is a method of parametric modeling which associates the value of a property of an element with the value of a parameter defined within that element's model, such that when the value of the parameter changes, the property value will update in response. For example, the Height property of a cylinder can be bound to a CylinderHeight parameter defined in the model. When the user modifies CylinderHeight's value, the height of the cylinder will change.

Remarks
Required library : DgnPlatform<ApiNumber>.lib i.e. DgnPlatform5.lib

Constructor & Destructor Documentation

Constructor.

Parameters
[in]instanceThe ECInstance hosting the dependent ECProperty
[in]accessStringThe access string of the dependent ECProperty value

Member Function Documentation

WCharCP GetAccessString ( ) const

Returns the access string of the bound property.

DGNPLATFORM_EXPORT bool GetControllingParameterAccessString ( WStringR  accessString,
ElementHandleCR  eh 
) const

Retrieves the access string of the active parameter to which the property represented by this specification is bound.

DGNPLATFORM_EXPORT bool HasControllingParameter ( ElementHandleCR  eh) const

Returns true if the property represented by this specification on the specified element is bound to an active parameter.

bool IsValid ( ) const

Returns true if the specification identifies a valid ECInstance.

DGNPLATFORM_EXPORT bool Schedule ( EditElementHandleR  eeh,
WCharCP  parameterAccessString 
) const

Schedules a dependency on the active parameter with the specified access string.

DGNPLATFORM_EXPORT bool ScheduleRemoval ( EditElementHandleR  eeh) const

Schedules the removal of the dependency defined by this specification.


The documentation for this struct was generated from the following file:

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.