SelectionPickPoint(String) Method

Prompts the user to pick a point on the active work plane while showing a custom status prompt string.

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

Syntax

public XYZ PickPoint(
	string statusPrompt
)

Public Function PickPoint ( 
	statusPrompt As String
) As XYZ

public:
XYZ^ PickPoint(
	String^ statusPrompt
)

member PickPoint : 
        statusPrompt : string -> XYZ

Parameters

statusPrompt String: Specifies the message shown on the status bar.

Return Value

XYZ

The point picked by user.

Note: if the user cancels the operation (for example, through ESC), the method will throw an OperationCanceledException instance.

Exceptions

Exception	Condition
ArgumentNullException	Thrown when the argument statusPrompt is .
InvalidOperationException	Thrown when no work plane set in current view.
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.
ForbiddenForDynamicUpdateException	Thrown if this method is called during dynamic update.

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.

Note: this method must not be called during dynamic update, otherwise ForbiddenForDynamicUpdateException will be thrown.

Reference

Selection Class

PickPoint Overload

Autodesk.Revit.UI.Selection Namespace