PromptForDoubleOrKeyword Method (ICommandMessage)

PromptForDoubleOrKeyword 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)

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

Keyword[out]
  Keyword input by the user

Value[out]
  Double value input by the user

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

# Syntax

Visual Basic |
--- | ---
    Function PromptForDoubleOrKeyword( _
       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 DefaultValue As System.Double, _
       ByRef Keyword As System.String, _
       ByRef Value As System.Double _
    ) As dsPromptResultType_e

C# |
--- | ---
    dsPromptResultType_e PromptForDoubleOrKeyword(
       System.string Prompt,
       System.string ErrorMsg,
       System.object GlobalKeywordStrArray,
       System.object LocalKeywordStrArray,
       System.int PromptInit,
       System.double DefaultValue,
       out System.string Keyword,
       out System.double Value
    )

JavaScript |
--- | ---
    PromptForDoubleOrKeyword(
       Prompt : String,
       ErrorMsg : String,
       GlobalKeywordStrArray : Array,
       LocalKeywordStrArray : Array,
       PromptInit : Number,
       DefaultValue : Number
    ) : {
       Keyword : String,
       Value : Number,
       Result : String
    }

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

C++ |
--- | ---
    DSRESULT PromptForDoubleOrKeyword(
       const dsString& Prompt,
       const dsString& ErrorMsg,
       const dsStringArray& GlobalKeywordStrArray,
       const dsStringArray& LocalKeywordStrArray,
       long PromptInit,
       double DefaultValue,
       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)
DefaultValue
  Default double value to display in the prompt in the command window (see Remarks)
Keyword[out]
  Keyword input by the user
Value[out]
  Double value 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.

Typically global keywords are created so that your application can run in any localized version of DraftSight. Users can also 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::PromptForDouble Method ()

# Availability

DraftSight V1R4.0