getFrameProperties: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{stub}} {{MacroFunction |name=getFrameProperties |version=1.5.4 |description= Returns a json object holding the properties associated with a given frame. The properties are {...") |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| (7 intermediate revisions by 4 users not shown) | |||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getFrameProperties(name) | getFrameProperties(name) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 16: | Line 16: | ||
|example= | |example= | ||
Opening up a frame | Opening up a frame | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[ | [frame5("Test", "title=My Frame; width=100; height=200; temporary=0; value=99"):{A frame}] | ||
</ | </syntaxhighlight> | ||
Getting the properties of the frame: | Getting the properties of the frame: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[getFrameProperties(" | [getFrameProperties("Test")] | ||
</ | </syntaxhighlight> | ||
The output will be: | The output will be: | ||
<syntaxhighlight lang="JSON"> | |||
{ | |||
"title": "My Frame", | |||
"tabtitle": "My Frame", | |||
"html5": 1, | |||
"temporary": 0, | |||
"visible": 1, | |||
"docked": 1, | |||
"floating": 0, | |||
"autohide": 0, | |||
"height": 1148, | |||
"width": 285, | |||
"undocked_x": 1053, | |||
"undocked_y": 358, | |||
"undocked_h": 225, | |||
"undocked_w": 252, | |||
"value": "99" | |||
} | |||
</syntaxhighlight> | |||
|changes= | |||
* '''1.11.0''' - Added more properties. | |||
}} | }} | ||
[[Category:Frame Function]] | [[Category:Frame Function]] | ||
Latest revision as of 23:59, 14 March 2023
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
getFrameProperties() Function
• Introduced in version 1.5.4
Returns a json object holding the properties associated with a given frame. The properties are
width, height, temporary, title, and value.Usage
getFrameProperties(name)Parameters
name- The name of the frame.
Example
Opening up a frame
[frame5("Test", "title=My Frame; width=100; height=200; temporary=0; value=99"):{A frame}]Getting the properties of the frame:
[getFrameProperties("Test")]The output will be:
{
"title": "My Frame",
"tabtitle": "My Frame",
"html5": 1,
"temporary": 0,
"visible": 1,
"docked": 1,
"floating": 0,
"autohide": 0,
"height": 1148,
"width": 285,
"undocked_x": 1053,
"undocked_y": 358,
"undocked_h": 225,
"undocked_w": 252,
"value": "99"
}
Version Changes
- 1.11.0 - Added more properties.