PromptForPoint2 Method (ICommandMessage)

PromptForPoint2 Method (ICommandMessage) | Send Feedback
See Also Example

Result[out]
  True if the prompt is displayed in the command window, false if not

Prompt
  Text of prompt

ShowRubberLine

  True to display a rubber line from the origin, or from the BasePointX, BasePointY, and BasePointZ coordinates, to the location of the cursor; false to not display the rubber line

BasePointX
  x coordinate for the point indicating where to start the rubber line (see Remarks)

BasePointY
  y coordinate for the point indicating where to start the rubber line (see Remarks)

BasePointZ
  z coordinate for the point indicating where to start the rubber line (see Remarks)

X[out]
  x coordinate for a point

Y[out]
  y coordinate for a point

Z[out]
  z coordinate for a point

Plane
  Projection plane cursor coordinates

Displays the specified prompt in the command window gets the x, y, and z coordinates specified by the user.

# Syntax

Visual Basic |
--- | ---
    Function PromptForPoint2( _
       ByVal Prompt As System.String, _
       ByVal ShowRubberLine As System.Boolean, _
       ByVal BasePointX As System.Double, _
       ByVal BasePointY As System.Double, _
       ByVal BasePointZ As System.Double, _
       ByRef X As System.Double, _
       ByRef Y As System.Double, _
       ByRef Z As System.Double, _
       ByVal Plane As MathPlane _
    ) As System.Boolean

C# |
--- | ---
    System.bool PromptForPoint2(
       System.string Prompt,
       System.bool ShowRubberLine,
       System.double BasePointX,
       System.double BasePointY,
       System.double BasePointZ,
       out System.double X,
       out System.double Y,
       out System.double Z,
       MathPlane Plane
    )

JavaScript |
--- | ---
    PromptForPoint2(
       Prompt : String,
       ShowRubberLine : Boolean,
       BasePointX : Number,
       BasePointY : Number,
       BasePointZ : Number,
       Plane : dsMathPlane
    ) : {
       X : Number,
       Y : Number,
       Z : Number,
       Result : Boolean
    }

COM native C++ |
--- | ---
    HRESULT PromptForPoint2(
       BSTR Prompt,
       VARIANT_BOOL ShowRubberLine,
       DOUBLE BasePointX,
       DOUBLE BasePointY,
       DOUBLE BasePointZ,
       DOUBLE* X,
       DOUBLE* Y,
       DOUBLE* Z,
       IMathPlane* Plane,
       VARIANT_BOOL* Result
    )

C++ |
--- | ---
    DSRESULT PromptForPoint2(
       const dsString& Prompt,
       bool ShowRubberLine,
       double BasePointX,
       double BasePointY,
       double BasePointZ,
       double* X,
       double* Y,
       double* Z,
       dsMathPlane* Plane,
       bool* Result
    )

#### Parameters

Prompt
  Text of prompt
ShowRubberLine

  True to display a rubber line from the origin, or from the BasePointX, BasePointY, and BasePointZ coordinates, to the location of the cursor; false to not display the rubber line

BasePointX
  x coordinate for the point indicating where to start the rubber line (see Remarks)
BasePointY
  y coordinate for the point indicating where to start the rubber line (see Remarks)
BasePointZ
  z coordinate for the point indicating where to start the rubber line (see Remarks)
X[out]
  x coordinate for a point
Y[out]
  y coordinate for a point
Z[out]
  z coordinate for a point
Plane
  Projection plane cursor coordinates
Result[out] or Return Value
  True if the prompt is displayed in the command window, false if not

# Example

Insert Splines (C#)
Insert Splines (VB.NET)
Insert Splines (VBA)

# Remarks

ShowRubberLine must be set to true for the values specified for BasePointX, BasePointY, or BasePointZ to have an effect. The rubber line extends to the location of the cursor in the drawing.

# See Also

####

ICommandMessage Interface
ICommandMessage Members
ICommandMessage::PromptForPointOrKeyword Method ()

# Availability

DraftSight V1R2.0