closeDialog: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Fixed the link I just added. :()
m (Fixed some typography)
Line 2: Line 2:
|name=closeDialog
|name=closeDialog
|version=1.3b49
|version=1.3b49
|description=Closes the specified macro dialog that was previously created using [[dialog | {{code | [dialog():]}}]] or [[frame_(roll_option) | {{code | [frame():]}}]] (yes, it works on frames even if the name implies otherwise).  If the  
|description=Closes the specified macro dialog that was previously created using {{roll | dialog}} or {{roll | frame}} (yes, it works on frames even if the name implies otherwise).  If the  
[[dialog]] is not open then the function has no effect.  
[[dialog]] is not open then the function has no effect.  



Revision as of 06:49, 18 April 2010

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 -->
}]