getMacroProps: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Added version.) |
Verisimilar (talk | contribs) mNo edit summary |
||
| Line 5: | Line 5: | ||
Returns a property list of the properties for a [[macro button]] for the [[Token:Current Token|Current Token]]. You can retrieve the index of a [[macro button]] with the [[Macros:Functions:getMacroIndexes|getMacroIndexes()]] function.The type of the value returned depends on the delimiter parameter. | Returns a property list of the properties for a [[macro button]] for the [[Token:Current Token|Current Token]]. You can retrieve the index of a [[macro button]] with the [[Macros:Functions:getMacroIndexes|getMacroIndexes()]] function.The type of the value returned depends on the delimiter parameter. | ||
* If the delimiter is not specified then a [[Macros:string propert list|string propert list]] is returned with the default value of 'l' is used. | * If the delimiter is not specified then a [[Macros:string propert list|string propert list]] is returned with the default value of 'l' is used. | ||
* If the delimiter | * If the delimiter {{code|"json"}} then a [[Macros:json object|json object]] is returned. | ||
* Otherwise a [[Macros:string property list|string property list]] is returned with the delimiter passed in. | * Otherwise a [[Macros:string property list|string property list]] is returned with the delimiter passed in. | ||
| Line 39: | Line 39: | ||
|changes= | |changes= | ||
{{change|1.3b49|Added {{code|json}} delimiter option.}} | |||
}} | }} | ||
[[Category:Metamacro Function]] | [[Category:Metamacro Function]] | ||
Revision as of 22:22, 22 March 2009
getMacroProps() Function
• Introduced in version 1.3b48
Returns a property list of the properties for a macro button for the Current Token. You can retrieve the index of a macro button with the getMacroIndexes() function.The type of the value returned depends on the delimiter parameter.
- If the delimiter is not specified then a string propert list is returned with the default value of 'l' is used.
- If the delimiter
"json"then a json object is returned. - Otherwise a string property list is returned with the delimiter passed in.
Usage
getMacroProps(label)getMacroProps(index)getMacroProps(label, delim)getMacroProps(index, delim)Where
- label is the label for the macro button. If you specify a label then all macro buttons on the token that have that label will be updated.
- index is the index of the macro button.
- delim is the delimiter used to separate the values in the string property list which defaults to ';' if not specified.
Valid Properties for Macro Buttons
- autoExec - true/false - Will the macro be automatically executed when the button is clicked on.
- color - The name of the color for the button.
- fontColor - The name of the font color for the button.
- includeLabel - true/false - Will the label be output when the button is clicked.
- group - The name of the group that the button is in.
- sortBy - The sort by value of the macro button.
- index - The index of the button.
- label - the lavle of the button.
- fontSize - The size of the font for the button.
- minWidth - the minimum width of the button.
Version Changes
- 1.3b49 - Added
jsondelimiter option.