closeDialog

From RPTools Wiki
Revision as of 06:38, 18 April 2010 by Azhrei (talk | contribs) (added indication that it works for frames as well as dialogs, per MacroDialogFunctions.java)
Jump to navigation Jump to search

closeDialog() Function

Introduced in version 1.3b49
Closes the specified macro dialog that was previously created using [dialog():] or [frame():] (yes, it works on frames even if the name implies otherwise). If the

dialog is not open then the function has no effect.

The most common use for this function is closing a dialog based from a macro that is run when clicking on a link or button for the

dialog that has no close button.

Usage

[h: closeDialog(name)]

Example

[h: closeDialog("CharacterSheet")]

Assuming a dialog called "Name Entry" has been created without the input flag but containing a form. In the macro called when the form is submitted you can use the following logic to check that the "name" field is not blank and close the dialog.

[h, if(listGet(macro.args, "name")), code: {
    [closeDialog("Name Entry")]
} ; {
    <!-- otherwise we would do something here to tell the user to provide a name -->
}]