PromptForAngleOrKeyword2 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 windows
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 the rubber line
DefaultValue
Default value to display in the prompt in the command windows
BasePoint
Base point
Keyword[out]
Keyword input by the users
Value[out]
Angle input by the user
Displays the specified prompt, local keywords, and default value for an angle in the command window and gets the user's input.

Syntax

Visual Basic 
Function PromptForAngleOrKeyword2( _
   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 PromptForAngleOrKeyword2( 
   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 
PromptForAngleOrKeyword2( 
   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 PromptForAngleOrKeyword2( 
   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 PromptForAngleOrKeyword2( 
   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 windows
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 the rubber line
DefaultValue
Default value to display in the prompt in the command windows
BasePoint
Base point
Keyword[out]
Keyword input by the users
Value[out]
Angle 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

Availability

DraftSight V1R5.0