SelectionUIOptions.ElementSelectsAsPinned
Method
Description:
Checks whether the specified element will be treated as pinned for the purposes of selection.
Checks whether the specified element will be treated as pinned for the purposes of selection.
Remarks:
To improve usability, the option to disable pinned selection has some additional intelligence beyond simply checking the pinned status. For example, if a model group is pinned, the corresponding attached detail group will also be treated as pinned for the purposes of selection. If this method returns true, the specified element will not be selectable when selection of pinned elements is disabled.
To improve usability, the option to disable pinned selection has some additional intelligence beyond simply checking the pinned status. For example, if a model group is pinned, the corresponding attached detail group will also be treated as pinned for the purposes of selection. If this method returns true, the specified element will not be selectable when selection of pinned elements is disabled.
Parameters
Parameter | Type | Description |
---|---|---|
document | Document | The document containing the element. |
element | Element | The element to check. |
Return Value
Type | Description |
---|---|
Boolean | True if the specified element should be treated as pinned for selection purposes, false otherwise. |
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | A non-optional argument was null |