| Revit Preview Release API |
| Selection..::..PickElementsByRectangle Method (ISelectionFilter) |
| Selection Class See Also |
Namespace: Autodesk.Revit.UI.Selection
Assembly: RevitAPIUI (in RevitAPIUI.dll) Version: 19.0.0.0 (19.0.0.405)
Syntax
| C# |
|---|
public IList<Element> PickElementsByRectangle( ISelectionFilter selectionFilter ) |
| Visual Basic |
|---|
Public Function PickElementsByRectangle ( _ selectionFilter As ISelectionFilter _ ) As IList(Of Element) |
| Visual C++ |
|---|
public: IList<Element^>^ PickElementsByRectangle( ISelectionFilter^ selectionFilter ) |
Parameters
- selectionFilter
- Type: Autodesk.Revit.UI.Selection..::..ISelectionFilter
The selection filter.
Return Value
A collection of elements selected by the user.
Note: if the user cancels the operation (for example, through ESC), the method will throw an OperationCanceledException instance.
Remarks
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.
Exceptions
| Exception | Condition |
|---|---|
| Autodesk.Revit.Exceptions..::..ArgumentNullException | Thrown when the selectionFilter is nullNothingnullptra null reference (Nothing in Visual Basic). |
| Autodesk.Revit.Exceptions..::..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. |
| Autodesk.Revit.Exceptions..::..ForbiddenForDynamicUpdateException | Thrown if this method is called during dynamic update. |