Namespace: Autodesk.Revit.UI.Selection Class: Selection

Selection.PickBox(PickBoxStyle, String)

Method

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

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

Syntax

public PickedBox PickBox(
	PickBoxStyle style,
	string statusPrompt
)

Public Function PickBox ( 
	style As PickBoxStyle,
	statusPrompt As String
) As PickedBox

public:
PickedBox^ PickBox(
	PickBoxStyle style, 
	String^ statusPrompt
)

member PickBox : 
        style : PickBoxStyle * 
        statusPrompt : string -> PickedBox

Parameters

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

Return Value

Type	Description
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.