getDialogProperties: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{stub}} {{MacroFunction |name=getDialogProperties |version=1.5.4 |description= Returns a json object holding the properties associated with a given dialog. The properties are...")
 
m (Conversion script moved page getDialogProperties to GetDialogProperties without leaving a redirect: Converting page title to first-letter uppercase)
(No difference)

Revision as of 22:33, 9 February 2023

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

getDialogProperties() Function

Introduced in version 1.5.4
Returns a json object holding the properties associated with a given dialog. The properties are width, height, temporary, title, and value.

Usage

getDialogProperties(name)

Parameters

  • name - The name of the dialog.

Example

Opening up a dialog
[dialog("Dialog Test", "width=300; height=200; temporary=0; title=A new title; value=data of relevance"): {test}]

Getting the properties of the dialog:

[getDialogProperties("Dialog Test")]

The output will be:

 {"width":300,"height":200,"temporary":0,"title":"A new title","value":"data of relevance"}