company logo

Property :: selected - Is instance selected

The property returns whether there is an instance selected (true) for the property handle or not (false). Selected instances need not necessarily be located. In contrast to positioned(), instances, which have been provided using the initializeInstance() function, are considered as selected as well. When the property handle refers to an attribute with a parent property handle it returns the selected state of the parent instance.

The property throws an exception, when the property handle is not valid. Note that the property also throws an exception, when the property instance has been modified by another property handle and the current handle contains unsaved modifications. In this case the instance remains selected, modifications of the current handle are canceled an the instance is reread.

Return value:  Success ( bool  )

The value is true when the function was executed successfully. Otherwise the value is set to false.

Implementation details

bool Property  :: selected (  )