Share

Selection.PickBox(PickBoxStyle, String) Method

Invokes a general purpose two-click editor that lets the user to specify a rectangular area on the screen.


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

Syntax

C#

public PickedBox PickBox(
	PickBoxStyle style,
	string statusPrompt
)

Parameters

style  PickBoxStyle
Specifies the value that controls the style of the pick box.
statusPrompt  String
The message shown on the status bar.

Return Value

PickedBox
The picked box that contains two XYZ points.

Exceptions

ExceptionCondition
ArgumentOutOfRangeExceptionThrown when the style is not a recognized value.
ArgumentNullExceptionThrown when the argument statusPrompt is nullptr.
OperationCanceledExceptionThrown 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.

Remarks

The method starts an editor and returns when it finishes. Returns a PickedBox that contains two XYZ points.

See Also

Reference

Was this information helpful?