getMacros: Difference between revisions
Jump to navigation
Jump to search
m (Macros:Functions:getMacros moved to getMacros: Moving out of Macros namespace.) |
(Added MacroFunction template and Metamacro Function category. Inserted version changes section.) |
||
| Line 1: | Line 1: | ||
= | {{MacroFunction | ||
|name=getMacros | |||
|description= | |||
Returns a list of the labels of all of the [[macro buttons]] on the [[Token:Current Token|Current Token]]. The type of the value returned depends on the delimiter parameter. | Returns a list of the labels of all of the [[macro buttons]] on the [[Token:Current Token|Current Token]]. The type of the value returned depends on the delimiter parameter. | ||
* If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of ',' is used. | * If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of ',' is used. | ||
| Line 7: | Line 7: | ||
* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | * Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | ||
|usage= | |||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: macros = getMacros()] | [h: macros = getMacros()] | ||
| Line 14: | Line 14: | ||
delim is the delimiter used to separate the values in the [[Macros:string list|string list]] which defaults to ',' if not specified. | delim is the delimiter used to separate the values in the [[Macros:string list|string list]] which defaults to ',' if not specified. | ||
|examples= | |||
To display all of the [[macro button]] labels on the current [[Token:token|token]] use. | To display all of the [[macro button]] labels on the current [[Token:token|token]] use. | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
| Line 21: | Line 20: | ||
[foreach(macro, macroLables, "<br>"): macro] | [foreach(macro, macroLables, "<br>"): macro] | ||
</source> | </source> | ||
|changes= | |||
* '''1.3b49''' - getMacros() will return a [[JSON array]] if the delim argument is "json". | |||
}} | |||
[[Category:Metamacro Function]] | |||
Revision as of 18:41, 7 March 2009
getMacros() Function
Returns a list of the labels of all of the macro buttons on the Current Token. The type of the value returned depends on the delimiter parameter.
- If the delimiter is not specified then a string list is returned with the default value of ',' is used.
- If the delimiter "json" then a json array is returned. (as of MapTool 1.3b49)
- Otherwise a string list is returned with the delimiter passed in.
Usage
[h: macros = getMacros()]
[h: macros = getMacros(delim)]delim is the delimiter used to separate the values in the string list which defaults to ',' if not specified.
Examples
To display all of the macro button labels on the current token use.
[h: macroLables = getMacros()]
[foreach(macro, macroLables, "<br>"): macro]Version Changes
- 1.3b49 - getMacros() will return a JSON array if the delim argument is "json".