getMacros: Difference between revisions

Revision as of 22:20, 22 March 2009

• Introduced in version 1.3b48

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.
Otherwise a string list is returned with the delimiter passed in.

getMacros()
getMacros(delim)

delim is the delimiter used to separate the values in the string list which defaults to ',' if not specified.

To display all of the macro button labels on the current token use.

[h: macroLables = getMacros()]
[foreach(macro, macroLables, "<br>"): macro]

@@ Line 5: / Line 5: @@
 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 ''"json"'' then a [[Macros:json array|json array]] is returned. '''(as of MapTool 1.3b49)'''
+* If the delimiter {{code|"json"}} then a [[Macros:json array|json array]] is returned.
 * Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in.
@@ Line 23: / Line 23: @@
 |changes=
-* '''1.3b49''' - getMacros() will return a [[JSON array]] if the delim argument is "json".
+{{change|1.3b49|Added {{code|json}} delimiter option.}}
 }}
 [[Category:Metamacro Function]]