SelectionTypes SelectionTypes SelectionTypes SelectionTypes Enum

Definition

Defines identifiers that indicate the type of a selection.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

public enum class SelectionTypes
[System.Flags]
[System.Runtime.InteropServices.ComVisible(true)]
public enum SelectionTypes
type SelectionTypes = 
Public Enum SelectionTypes
Inheritance
SelectionTypesSelectionTypesSelectionTypesSelectionTypes
Attributes

Fields

Add Add Add Add 64

Represents an add selection that adds the selected components to the current selection, maintaining the current set of selected components.

Auto Auto Auto Auto 1

Represents a regular selection. The selection service responds to the CTRL and SHIFT keys to support adding or removing components to or from the selection.

Click Click Click Click 16

Represents a selection that occurs when a user clicks a component. If the newly selected component is already selected, it is promoted to be the primary selected component rather than being canceled.

MouseDown MouseDown MouseDown MouseDown 4

Represents a selection that occurs when the user presses on the mouse button while the mouse pointer is over a component. If the component under the pointer is already selected, it is promoted to become the primary selected component rather than being canceled.

MouseUp MouseUp MouseUp MouseUp 8

Represents a selection that occurs when the user releases the mouse button immediately after a component has been selected. If the newly selected component is already selected, it is promoted to be the primary selected component rather than being canceled.

Normal Normal Normal Normal 1

Represents a regular selection. The selection service responds to the CTRL and SHIFT keys to support adding or removing components to or from the selection.

Primary Primary Primary Primary 16

Represents a primary selection that occurs when a user clicks on a component. If a component in the selection list is already selected, the component is promoted to be the primary selection.

Remove Remove Remove Remove 128

Represents a remove selection that removes the selected components from the current selection, maintaining the current set of selected components.

Replace Replace Replace Replace 2

Represents a selection that occurs when the content of a selection is replaced. The selection service replaces the current selection with the replacement.

Toggle Toggle Toggle Toggle 32

Represents a toggle selection that switches between the current selection and the provided selection. If a component is already selected and is passed into SetSelectedComponents with a selection type of Toggle, the component selection will be canceled.

Valid Valid Valid Valid 31

Identifies the valid selection types as Normal, Replace, MouseDown, MouseUp, or Click.

Remarks

Components of a designer document can be selected using the SetSelectedComponents method of the ISelectionService. Some types of actions can operate on a selected component or group of selected components. The ISelectionService keeps track of the selection type of the current selection. These selection type identifiers indicate whether the selection was completed using a single click, a mouse down or mouse up selection, whether the selection should replace the previous selection, or use the default selection mode.

Use the SelectionTypes enumeration to specify the type of a selection when setting a new selection using the SetSelectedComponents method.

Applies to

See Also