IAdeUICallbacks::AskMsgText

ADE User Guide > ADE Server Class Reference > IAdeUICallbacks

string IAdeUICallbacks:: AskMsgText([in] string question, [in] string title, [in] long maxText, [in] string defaultText, [in] bool bPassword, [out] bool* bCancel)

Called when the AskMsgText() function is evaluated. You implement this method to display a user-interface element that displays a question and allows the user to enter some text.

Parameters

• «question»: the question to show the user
• «title»: the caption for the dialog shown
• «maxText»: the maximum number of characters allowed in the response
• «defaultText»: The default, or initial text to show in the dialog.
• «bPassword»: a Boolean indicating whether this is a password entry. When true, your input should display a block character such as ● in place of the characters being entered.

Return values

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

The return value for the function should be the text entered by the user.

See Also

• AskMsgText function
• IAdeUICallbacks::AskMsgNumber, IAdeUICallbacks::AskMsgChoice, IAdeUICallbacks::AskMsgComboBox