IAdeUICallbacks::AskMsgChoice

Outdated translations are marked like this.

ADE User Guide > ADE Server Class Reference > IAdeUICallbacks

long IAdeUICallbacks::AskMsgChoice(([in] string question, [in] string title, [in] array<string> optionList, [in] long defaultPosition, [in] bool bShowAll, [out] bool * bCancel)

Called when the AskMsgChoice() function is evaluated, and a standard choice (non-combo box) is requested (the «comboBox» parameter to AskMsgChoice is either omitted or specified as false). The AskMsgChoice function might alternately call the IAdeUICallbacks::AskMsgComboBox() function when the «comboBox» parameter is specified as true.

You implement this method to display a user-interface element that displays a question and allows the user to select a single option (or All) among a list of options.

Parameters

  • «question»: the question to show the user
  • «title»: the caption for the dialog shown
  • «optionList»: The list of options to display.
  • «defaultPosition»: The position of the option initially selected. A value of 1 means the first option is selected. A value of 0 means the All option should be initially selected.
  • «bShowAll»: a Boolean indicating whether the All selection should be shown as an option.

Return value

The 1-based position of the selected item, or 0 if All is selected.

Set «bCancel» to True if the user presses Cancel, False otherwise. True will cause the current computation to be aborted.

Examples

See Also

Comments
Loading comments...