Selection.PickBox(PickBoxStyle, String)

Public Class

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: 25.0.0.0 (25.0.0.0)

Syntax

public PickedBox PickBox(
  PickBoxStyle style,
  string statusPrompt
)

Parameters

style PickBoxStyle

Specifies the value that controls the style of the pick box.

statusPromptString

The message shown on the status bar.

Return Value

PickedBox
The picked box that contains two XYZ points.

Exceptions

Exception

Condition

---

ArgumentOutOfRangeException

Thrown when the style is not a recognized value.

---

ArgumentNullException

Thrown when the argument statusPrompt is ..

---

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.

---

Remarks

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