SelectionUIOptions

Public Class

Provides access to user settings related to how selection will behave in Revit’s UI.

Inheritance Hierarchy

System.Object
Autodesk.Revit.UI.SelectionUIOptions

Assembly: RevitAPIUI (in RevitAPIUI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class SelectionUIOptions : IDisposable

The SelectionUIOptions type exposes the following members.

Properties

Name

Description

Public Property
ActivateControlsAndDimensionsOnMultiSelect

Indicates whether controls and temporary dimensions are activated on selection of multiple elements.

Public Property
DragOnSelection

Indicates whether elements can be dragged immediately when they are selected.

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

Public Property
SelectFaces

Indicates whether elements can be selected by clicking on the interior of a face.

Public Property
SelectLinks

Indicates whether Revit and CAD link instances can be selected.

Public Property
SelectPinned

Indicates whether pinned elements can be selected.

Public Property
SelectUnderlay

Indicates whether elements that are displayed as underlay can be selected.

Methods

Name

Description

Public Method

Dispose

Releases all resources used by the SelectionUIOptions

Public Method
Static Member
ElementSelectsAsPinned

Checks whether the specified element will be treated as pinned for the purposes of selection.

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method
Static Member

GetSelectionUIOptions

Returns the current user’s SelectionOptions.

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

Remarks

The settings in this class define how selection will behave when the user is selecting one or more elements in a graphical view. These settings do not affect programmatic selection behavior. Some UI commands may override the user’s settings while the command is active.

These settings are per user and will affect the selection behavior in all projects and families. The settings are not stored in the project.