createMacro

Function createMacro

 Note: This refers to a proposed change that has not been implemented in the main code base yet.

Creates a macro button for the current token and returns the index of the newly created button.

Usage

[h: buttonIndex =  createMacro(label, command)]
[h: buttonIndex = createMacro(label, command, props)]
[h: buttonIndex = createMacro(label, command, props, delim)]

Where

• label is the label for the macro button.
• command is the command to run when the macro button is clicked.
• props is a string property list containing the properties for the 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.
• fontSize - The size of the font for the button.
• minWidth - the minimum width of the button.

Examples

[createMacro("Test", "this is a test", "autoExec=true;color=blue", ";") ]
[createMacro("Another Test", "this is a test", "autoExec=true;color=red;fontColor=white", ";") ]

Will create the following buttons on the current token.