SelectionPickObjects(ObjectType, ISelectionFilter, String, IListReference) Method

Prompts the user to select multiple objects which pass a custom filter while showing a custom status prompt string. A preselected set of objects may be supplied and will be selected at the start of the selection.

Namespace: Autodesk.Revit.UI.Selection
Assembly: RevitAPIUI (in RevitAPIUI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

C++

Copy

public IList<Reference> PickObjects(
	ObjectType objectType,
	ISelectionFilter selectionFilter,
	string statusPrompt,
	IList<Reference> pPreSelected
)

Public Function PickObjects ( 
	objectType As ObjectType,
	selectionFilter As ISelectionFilter,
	statusPrompt As String,
	pPreSelected As IList(Of Reference)
) As IList(Of Reference)

public:
IList<Reference^>^ PickObjects(
	ObjectType objectType, 
	ISelectionFilter^ selectionFilter, 
	String^ statusPrompt, 
	IList<Reference^>^ pPreSelected
)

member PickObjects : 
        objectType : ObjectType * 
        selectionFilter : ISelectionFilter * 
        statusPrompt : string * 
        pPreSelected : IList<Reference> -> IList<Reference>

Parameters

objectType ObjectType: Specifies the type of object to be selected.
selectionFilter ISelectionFilter: The selection filter.
statusPrompt String: The message shown on the status bar.
pPreSelected IListReference: The previously selected set of objects.

Return Value

IListReference

A collection of references selected by the user.

Note: if the user cancels the operation (for example, through ESC), the method will throw an OperationCanceledException instance.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	Thrown when the objectType is not a recognized value.
ArgumentNullException	Thrown when the selectionFilter is .
InvalidOperationException	Thrown when the Revit user cancelled this operation. Thrown when pPreSelected references has objects that are not the type of objectType. Thrown when objectType is PointOnElement which is not supported for selection involving preselected items.
OperationCanceledException	Thrown when the Revit user cancelled this operation. Thrown when the Revit user tried to switch the active view, close the active document or Revit application when responding to this mode.
ForbiddenForDynamicUpdateException	Thrown if this method is called during dynamic update.

Remarks

The user will be shown "Finish" and "Cancel" buttons on the dialog bar to complete the selection operation. Uncheck the "Multiple" check-box to select single object and it will return the selected object directly.

The previously selected set of objects will be highlighted.

Revit users will be permitted to manipulate the Revit view (zooming, panning, and rotating the view), but will not be permitted to click other items in the Revit user interface. Users are not permitted to switch the active view, close the active document or Revit application in the pick session, otherwise an exception will be thrown.

The selection will not be automatically added to the active selection buffer.

Note: this method must not be called during dynamic update, otherwise ForbiddenForDynamicUpdateException will be thrown.

Reference

Selection Class

PickObjects Overload

Autodesk.Revit.UI.Selection Namespace