PromptForSelectionOrKeyword Method (ICommandMessage)

PromptForSelectionOrKeyword Method (ICommandMessage) | Send Feedback
See Also

Result[out]
  Result as defined in dsPromptResultType_e

SingleSelection
  True to prompt for a single selection, false to prompt for multiple selections

Prompt[out]
  Prompt to display in the command window

ErrorMsg
  Error message to display in the command window when the user's 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)

Keyword[out]
  Keyword input by the user

Displays the specified prompt and local keywords for selecting one or more entities in the command window and gets the user's input.

# Syntax

Visual Basic |
--- | ---
    Function PromptForSelectionOrKeyword( _
       ByVal SingleSelection As System.Boolean, _
       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, _
       ByRef Keyword As System.String _
    ) As dsPromptResultType_e

C# |
--- | ---
    dsPromptResultType_e PromptForSelectionOrKeyword(
       System.bool SingleSelection,
       System.string Prompt,
       System.string ErrorMsg,
       System.object GlobalKeywordStrArray,
       System.object LocalKeywordStrArray,
       System.int PromptInit,
       out System.string Keyword
    )

JavaScript |
--- | ---
    PromptForSelectionOrKeyword(
       SingleSelection : Boolean,
       Prompt : String,
       ErrorMsg : String,
       GlobalKeywordStrArray : Array,
       LocalKeywordStrArray : Array,
       PromptInit : Number
    ) : {
       Keyword : String,
       Result : String
    }

COM native C++ |
--- | ---
    HRESULT PromptForSelectionOrKeyword(
       VARIANT_BOOL SingleSelection,
       BSTR Prompt,
       BSTR ErrorMsg,
       VARIANT GlobalKeywordStrArray,
       VARIANT LocalKeywordStrArray,
       LONG PromptInit,
       BSTR* Keyword,
       dsPromptResultType_e* Result
    )

C++ |
--- | ---
    DSRESULT PromptForSelectionOrKeyword(
       bool SingleSelection,
       const dsString& Prompt,
       const dsString& ErrorMsg,
       const dsStringArray& GlobalKeywordStrArray,
       const dsStringArray& LocalKeywordStrArray,
       long PromptInit,
       dsString* Keyword,
       dsPromptResultType_e* Result
    )

#### Parameters

SingleSelection
  True to prompt for a single selection, false to prompt for multiple selections
Prompt[out]
  Prompt to display in the command window
ErrorMsg
  Error message to display in the command window when the user's 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)
Keyword[out]
  Keyword 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.

You can allow or disallow the selection of an entity by calling ISelectionManager::RemoveOptions before calling this method.

# See Also

####

ICommandMessage Interface
ICommandMessage Members
ICommandMessage::PromptForSelection Method ()
ISelectionManager::PaperSpaceSelectionEnabled Property ()

# Availability

DraftSight V1R4.0