closeDialog: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "<source" to "<syntaxhighlight")
 
(9 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{stub}}
{{MacroFunction
{{MacroFunction
|name=closeDialog
|name=closeDialog
|version=1.3b49
|version=1.3b49
|description=Closes the specified macro dialog.
|description=Closes the specified macro dialog that was previously created using {{roll | 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 {{roll|dialog}}. Frames cant be closed with this. But there is a new analog function available for that, too. See {{func|closeFrame}}
 


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: closeDialog(name)]
[h: closeDialog(name)]
</source>
</syntaxhighlight>


|example=
|example=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: closeDialog("CharacterSheet")]   
[h: closeDialog("CharacterSheet")]   
</source>
</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]].
<syntaxhighlight lang="mtmacro" line>
[h, if(listGet(macro.args, "name")), code: {
    [closeDialog("Name Entry")]
} ; {
    <!-- otherwise we would do something here to tell the user to provide a name -->
}]
</syntaxhighlight>
}}
}}
[[Category:Dialog Function]]
[[Category:Dialog Function]]

Latest revision as of 20:59, 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

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