Go to: Synopsis. Flags. Return value. MEL examples.

Synopsis

promptDialog [-backgroundColor float float float] [-button string] [-cancelButton string] [-defaultButton string] [-dismissString string] [-message string] [-messageAlign string] [-parent string] [-scrollableField boolean] [-text string] [-title string]

promptDialog is undoable, queryable, and editable.

The promptDialog command creates a modal dialog with a message to the user, a text field in which the user may enter a response, and a variable number of buttons to dismiss the dialog. The dialog is dismissed when the user presses any button or chooses the close item from the window menu. In the case where a button is pressed then the name of the button selected is returned. If the dialog is dismissed via the close item then the string returned is specified by the -ds/dismissString flag.

The default behaviour when no arguments are specified is to create an empty single button dialog.

To obtain the text entered by the user simply query the -tx/text flag.

Flags

backgroundColor, button, cancelButton, defaultButton, dismissString, message, messageAlign, parent, scrollableField, text, title
Long name (short name) [argument types] Properties
-title(-t) string create
The dialog title.
-message(-m) string create
The message text appearing in the dialog.
-messageAlign(-ma) string create
Align the message left, center, or right.
-text(-tx) string createquery
The field text.

In query mode, this flag needs a value.
-scrollableField(-sf) boolean create
By default a single line text field is used in the dialog. Specify true for a multi-line scroll field.
-button(-b) string createmultiuse
Create a button with the given string as it's text.
-defaultButton(-db) string create
The default button is activated by pressing the enter key. Note that this flag does not create a button, it simply indicates which button created via the -b/button flag shall respond to the enter key.
-cancelButton(-cb) string create
The cancel button is activated by pressing the escape key. Note that this flag does not create a button, it simply indicates which button created via the -b/button flag shall respond to the escape key.
-dismissString(-ds) string create
The string returned when the user selects the 'Close' item from the Window Manager menu. If this flag is not set then the string "dismiss" is returned.
-parent(-p) string create
Specify the parent window for the dialog. The dialog will be centered on this window and raise and lower with it's parent. By default, the dialog is not parented to a particular window and is simply centered on the screen.
-backgroundColor(-bgc) float float float create
The background color of the dialog. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0. (Windows only flag)
Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can be used more than once in a command

Return value


A string indicating how the dialog was dismissed. If a button is pressed then the label of the button is returned. If the dialog is closed then the value for the flag -ds/dismissString is returned.

MEL examples

// Create an OK/Cancel prompt dialog.
//
// +-+---------------------+
// |-|    Rename Object    |
// +-----------------------+
// | Enter Name:           |
// | +-------------------+ |
// | |                   | |
// | |                   | |
// | +-------------------+ |
// +-----------------------+
// | +-------+  +--------+ |
// | |  OK   |  | Cancel | |
// | +-------+  +--------+ |
// +-----------------------+
//
string $text;
string $result = `promptDialog
    -title "Rename Object"
    -message "Enter Name:"
    -button "OK" -button "Cancel"
    -defaultButton "OK" -cancelButton "Cancel"
    -dismissString "Cancel"`;

if ($result == "OK") {
    $text = `promptDialog -query -text`;
}