closeDialog: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page CloseDialog to closeDialog: Converting page titles to lowercase) |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| Line 14: | Line 14: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: closeDialog(name)] | [h: closeDialog(name)] | ||
</ | </syntaxhighlight> | ||
|example= | |example= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: closeDialog("CharacterSheet")] | [h: closeDialog("CharacterSheet")] | ||
</ | </syntaxhighlight> | ||
Assuming a [[dialog]] called "Name Entry" has been created without the input flag but containing a form. In the macro called when the | Assuming a [[dialog]] called "Name Entry" has been created without the input flag but containing a form. In the macro called when the | ||
| Line 29: | Line 29: | ||
<!-- otherwise we would do something here to tell the user to provide a name --> | <!-- otherwise we would do something here to tell the user to provide a name --> | ||
}] | }] | ||
</ | </syntaxhighlight> | ||
}} | }} | ||
[[Category:Dialog Function]] | [[Category:Dialog Function]] | ||
Revision as of 17:08, 14 March 2023
closeDialog() Function
• Introduced in version 1.3b49
Closes the specified macro dialog that was previously created using [ dialog():]. 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.
NOTE In later versions of maptool (tested in b74) this works only for dialogs opened with [dialog():]. Frames cant be closed with this. But there is a new analog function available for that, too. See closeFrame()Usage
<source lang="mtmacro" line> [h: closeDialog(name)] </syntaxhighlight>
Example
<source lang="mtmacro" line>
[h: closeDialog("CharacterSheet")] </syntaxhighlight>
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. <source lang="mtmacro" line> [h, if(listGet(macro.args, "name")), code: {
[closeDialog("Name Entry")]
} ; { }]
</syntaxhighlight>