SelectionPickObject(ObjectType, ISelectionFilter, String) Method

public Reference PickObject(
	ObjectType objectType,
	ISelectionFilter selectionFilter,
	string statusPrompt
)

Public Function PickObject ( 
	objectType As ObjectType,
	selectionFilter As ISelectionFilter,
	statusPrompt As String
) As Reference

public:
Reference^ PickObject(
	ObjectType objectType, 
	ISelectionFilter^ selectionFilter, 
	String^ statusPrompt
)

member PickObject : 
        objectType : ObjectType * 
        selectionFilter : ISelectionFilter * 
        statusPrompt : string -> 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.

Return Value

A reference object selected by user.

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

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