SelectionPick |
Namespace: Autodesk.Revit.UI.Selection
Assembly: RevitAPIUI (in RevitAPIUI.dll) Version: 25.0.0.0 (25.0.0.0)
public Reference PickObject( ObjectType objectType )
Public Function PickObject ( objectType As ObjectType ) As Reference
public: Reference^ PickObject( ObjectType objectType )
member PickObject : objectType : ObjectType -> Reference
Parameters
- objectType ObjectType
- Specifies the type of object to be selected.
Return Value
ReferenceA reference object selected by 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. |
| OperationCanceledException | Thrown when the Revit user cancels 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. |
RemarksRevit 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.
ExampleSelection choices = uidoc.Selection; // Pick one object from Revit. Reference hasPickOne = choices.PickObject(ObjectType.Element); if (hasPickOne != null) { TaskDialog.Show("Revit", "One element selected."); }
Dim choices As Selection = uidoc.Selection ' Pick one object from Revit. Dim hasPickOne As Reference = choices.PickObject(ObjectType.Element) If hasPickOne IsNot Nothing Then TaskDialog.Show("Revit", "One element selected.") End If
No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.