Selection

Selection

Choose your operating system:

Windows

macOS

Linux

On this page

Actions

Allow Selection Modifiers

Test to see whether selection modifiers (Ctrl or Shift) are allowed while selecting this element.

Target is Typed Element Selection Set

Can Deselect Element

Test to see whether the given element can be deselected.

Target is Typed Element Selection Set

Can Select Element

Test to see whether the given element can be selected.

Target is Typed Element Selection Set

Clear Selection

Clear the current selection.

Target is Typed Element Selection Set

Count Selected Elements

Count the number of selected elements, optionally filtering to elements that implement the given interface.

Target is Typed Element Selection Set

Count Selected Objects

Count the number of selected objects.

Target is Typed Element Selection Set

Deselect Element

Attempt to deselect the given element.

Target is Typed Element Selection Set

Deselect Elements

Attempt to deselect the given elements.

Target is Typed Element Selection Set

Deselect Elements from List

Attempt to deselect the given elements.

Target is Typed Element Selection Set Library

Get Bottom Selected Object

Get the last selected object of the given type.

Target is Typed Element Selection Set

Get Current Selection State

Serializes the current selection set. The calling code is responsible for storing any state information. The selection set can be returned to a prior state using RestoreSelectionState.

Target is Typed Element Selection Set

Get Normalized Element List

Get a normalized version of the given element list that can be used to perform operations like gizmo manipulation, deletion, copying, etc. This will do things like expand out groups, and resolve any parent<->child elements so that duplication operations aren't performed on both the parent and the child.

Target is Typed Element Selection Set Library

Get Normalized Selection

Get a normalized version of this selection set that can be used to perform operations like gizmo manipulation, deletion, copying, etc. This will do things like expand out groups, and resolve any parent<->child elements so that duplication operations aren't performed on both the parent and the child.

Target is Typed Element Selection Set Library

Get Num Selected Elements

Get the number of selected elements.

Target is Typed Element Selection Set

Get Selected Element Handles

Get the handle of every selected element, optionally filtering to elements that implement the given interface.

Target is Typed Element Selection Set

Get Selected Objects

Get the array of selected objects from the currently selected elements.

Target is Typed Element Selection Set

Get Selection Element

Given an element, return the element that should actually perform a selection operation.

Target is Typed Element Selection Set

Get Top Selected Object

Get the first selected object of the given type.

Target is Typed Element Selection Set

Has Selected Elements

Test whether there selected elements, optionally filtering to elements that implement the given interface.

Target is Typed Element Selection Set

Has Selected Objects

Test whether there are any selected objects.

Target is Typed Element Selection Set

Is Element Selected

Test to see whether the given element is currently considered selected.

Target is Typed Element Selection Set

On Pre Selection Change

On Pre Selection Change: Delegate that is invoked whenever the underlying element list is potentially about to change.

On Selection Change

On Selection Change: Delegate that is invoked whenever the underlying element list has been changed.

Restore Selection State

Restores the selection set from the given state. The calling code is responsible for managing any undo state.

Target is Typed Element Selection Set

Select Element

Attempt to select the given element.

Target is Typed Element Selection Set

Select Elements

Attempt to select the given elements.

Target is Typed Element Selection Set

Select Elements from List

Attempt to select the given elements.

Target is Typed Element Selection Set Library

Set Selection

Attempt to make the selection the given elements. Note: Equivalent to calling ClearSelection then SelectElements, but happens in a single batch.

Target is Typed Element Selection Set

Set Selection from List

Attempt to make the selection the given elements. Note: Equivalent to calling ClearSelection then SelectElements, but happens in a single batch.

Target is Typed Element Selection Set Library