FORMULA LANGUAGE


@Prompt
Example

Displays a dialog box to the user and returns a text value based on the user's actions in the dialog box. @Prompt is useful for prompting a user for information and determining a course of action based on the user's input.

Summary of Dialog Box Styles

This table shows the different styles of dialog boxes you can display. @Prompt accepts parameters and returns a value based on the style you indicate.
StylePurposeContainsReturn value
ChooseDatabaseAllows user to select a databaseControls and displays for browsing databases; Open, Select, Cancel, Browse, Help, and About buttonsText list of 3 values. Server name, file name, and title of database. Returns null for server name if the database is local.
LocalBrowseAllows user to select a file name from the local file systemControls and displays for browsing local file system; Select, Cancel, and Network or Help buttons Text. File name that user selected or entered.
OkDisplays an informational messageTitle and prompt; OK button 1 (True).
OkCancelComboAllows user to select one value from a drop-down list of choicesTitle and prompt; List of choices; OK and Cancel buttonsText. Value that user selected.
OkCancelEditAllows user to type in text inputTitle and prompt; Text box for input; OK and Cancel buttonsText. Value that user entered.
OkCancelEditComboAllows user to select one value from a list of choices, or type in a different valueTitle and prompt; List of choices with text box; OK and Cancel buttonsText. Value that user selected or entered.
OkCancelListAllows user to select one value from a list of choicesTitle and prompt; List of choices; OK and Cancel buttonsText. Value that user selected.
OkCancelListMultAllows user to select multiple values from a list of choicesTitle and prompt; List of choices; OK and Cancel buttonsText list. All values that user selected.
PasswordAllows user to enter password without displaying it on the screenTitle and prompt; Text box that accepts and hides user input; OK and Cancel buttonsText. Password that user entered.
YesNoAllows user to make a Yes/No decisionTitle and prompt; Yes and No buttons1 (True, Yes) or 0 (False, No).
YesNoCancelAllows user to make a Yes/No decision, or CancelTitle and prompt; Yes, No, and Cancel buttons1 (True, Yes), 0 (False, No), or -1 (Cancel).

Syntax

@Prompt( [style] : [NoSort] ; title ; prompt ; defaultChoice ; choiceList ; filetype )

Parameters

[style]


[NoSort]
title
prompt
defaultChoice
choiceList
filetype
Return value

choice

Usage

Use @Prompt in field formula, toolbar button, manual agent, form action, and view action formulas. This function does not work in column, selection, mail agent, or scheduled agent formulas, and has limited usefulness in window title and form formulas.

The title and prompt parameters are scalar. If you enter a list, only the first element displays. Use @Implode to convert the list to a string.

You cannot use this function in Web applications.

Language cross-reference

InputBox function of LotusScript language

DialogBoxCanceled property of LotusScript NotesUIDocument class

Prompt method of LotusScript NotesUIWorkspace class

Example
See Also