PromptForDistanceOrKeyword2 Method (ICommandMessage)

PromptForDistanceOrKeyword2 Method (ICommandMessage) | Send Feedback
See Also

Result[out]
  Result as defined in dsPromptResultType_e

Prompt[out]
  Text to display as the prompt in the command window

ErrorMsg
  Error message to display in the command window when the user input is invalid

GlobalKeywordStrArray
  Array of global keywords, which are typically language independent (see Remarks)

LocalKeywordStrArray
  Array of local keywords, which are typically translated to the local language (see Remarks)

PromptInit
  Prompt initialization as defined in dsPromptInit_e (see Remarks)

ShowRubberLine
  True to display a rubber line from BasePoint to the location of the cursor, false to not display a rubber line

DefaultValue
  Default double value to display in the prompt in the command window (see Remarks)

BasePoint
  Base point

Keyword[out]
  Keyword input by the user

Value[out]
  Linear distance input by the user

Displays the specified prompt, local keywords, and default value for the linear distance in the command window and gets the user's input.

# Syntax

Visual Basic |
--- | ---
    Function PromptForDistanceOrKeyword2( _
       ByVal Prompt As System.String, _
       ByVal ErrorMsg As System.String, _
       ByVal GlobalKeywordStrArray As System.Object, _
       ByVal LocalKeywordStrArray As System.Object, _
       ByVal PromptInit As System.Integer, _
       ByVal ShowRubberLine As System.Boolean, _
       ByVal DefaultValue As System.Double, _
       ByVal BasePoint As MathPoint, _
       ByRef Keyword As System.String, _
       ByRef Value As System.Double _
    ) As dsPromptResultType_e

C# |
--- | ---
    dsPromptResultType_e PromptForDistanceOrKeyword2(
       System.string Prompt,
       System.string ErrorMsg,
       System.object GlobalKeywordStrArray,
       System.object LocalKeywordStrArray,
       System.int PromptInit,
       System.bool ShowRubberLine,
       System.double DefaultValue,
       MathPoint BasePoint,
       out System.string Keyword,
       out System.double Value
    )

JavaScript |
--- | ---
    PromptForDistanceOrKeyword2(
       Prompt : String,
       ErrorMsg : String,
       GlobalKeywordStrArray : Array,
       LocalKeywordStrArray : Array,
       PromptInit : Number,
       ShowRubberLine : Boolean,
       DefaultValue : Number,
       BasePoint : dsMathPoint
    ) : {
       Keyword : String,
       Value : Number,
       Result : String
    }

COM native C++ |
--- | ---
    HRESULT PromptForDistanceOrKeyword2(
       BSTR Prompt,
       BSTR ErrorMsg,
       VARIANT GlobalKeywordStrArray,
       VARIANT LocalKeywordStrArray,
       LONG PromptInit,
       VARIANT_BOOL ShowRubberLine,
       DOUBLE DefaultValue,
       IMathPoint* BasePoint,
       BSTR* Keyword,
       DOUBLE* Value,
       dsPromptResultType_e* Result
    )

C++ |
--- | ---
    DSRESULT PromptForDistanceOrKeyword2(
       const dsString& Prompt,
       const dsString& ErrorMsg,
       const dsStringArray& GlobalKeywordStrArray,
       const dsStringArray& LocalKeywordStrArray,
       long PromptInit,
       bool ShowRubberLine,
       double DefaultValue,
       dsMathPoint* BasePoint,
       dsString* Keyword,
       double* Value,
       dsPromptResultType_e* Result
    )

#### Parameters

Prompt[out]
  Text to display as the prompt in the command window
ErrorMsg
  Error message to display in the command window when the user input is invalid
GlobalKeywordStrArray
  Array of global keywords, which are typically language independent (see Remarks)
LocalKeywordStrArray
  Array of local keywords, which are typically translated to the local language (see Remarks)
PromptInit
  Prompt initialization as defined in dsPromptInit_e (see Remarks)
ShowRubberLine
  True to display a rubber line from BasePoint to the location of the cursor, false to not display a rubber line
DefaultValue
  Default double value to display in the prompt in the command window (see Remarks)
BasePoint
  Base point
Keyword[out]
  Keyword input by the user
Value[out]
  Linear distance input by the user
Result[out] or Return Value
  Result as defined in dsPromptResultType_e

# Remarks

Local keywords can be seen in the prompt in the command window during user interaction. Global keywords cannot be seen in the prompt in the command window. However, users can type global keywords at the prompt in the command window if they know them.

If the PromptInit parameter is set to:

- dsPromptInit_e.dsPromptInit_NoDefault and a value is specified for DefaultValue, then the value is not used or displayed in the prompt in the command window.
- dsPromptInit_e.UsePromptExplanation, then call ICommandMessage::PromptExplanation to specify the text for PromptInit.

# See Also

####

ICommandMessage Interface
ICommandMessage Members
ICommandMessage::PromptForDistance Method ()

# Availability

DraftSight V1R6.0