BBjPrompt::show

Description

In BBj 25.03 and higher, this method shows the BBjPrompt dialog, waits for the user to type a value, then returns that string to the application. If the user cancels the dialog by clicking Cancel or pressing Esc, it returns "::CANCEL::".

Syntax

Return Value Method
String show()

Parameters

None.

Return Value

BBjPrompt::show prompts the user to type a value into a dialog box, then returns that string to the application. If the user cancels the dialog by clicking Cancel or pressing Esc, it returns "::CANCEL::".

If a timeout option is specified and the user made no selection within the specified number of seconds, the initial default value is returned, or "" if no init() value was specified.

Example

print bbjapi().prompt("Message").title("Title").init("Default").show()

See Also

BBjAPI

PROMPT() Function - Prompt For String Value

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.