User Tools
manual:Plug_In_Actions
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
manual:Plug_In_Actions [2021/06/01 17:31] JMichaelTX [Retrieving Parameters in a Script] |
manual:Plug_In_Actions [2021/06/01 23:58] JMichaelTX [Plist Parameters] |
||
|---|---|---|---|
| Line 86: | Line 86: | ||
| ==== Plist Parameters ==== | ==== Plist Parameters ==== | ||
| - | |||
| - | |||
| - | Each parameter in the Parameters array is a dictionary with the following keys: | ||
| ^ Parameter Key ^ Description ^ | ^ Parameter Key ^ Description ^ | ||
| - | ^ Label | **Name of the parameter**.\\ The same rules as Keyboard Maestro Variable Names apply.\\ The label is displayed to the user and used to pass the parameter to the script.\\ Obviously, the label must be unique amongst all parameters | | + | ^ Label | **Name of the parameter**.<WRAP> |
| - | ^ Type | **Type of the parameter**.\\ Must be one of the following:\\ _(Text in italics is info, and not part of the Type)_\\ • String _(single line)_\\ • TokenString\\ • Calculation\\ • Text _(multi-line)_\\ • TokenText\\ • Checkbox _(0 or 1)_\\ • PopupMenu\\ • Hidden\\ The Type specifies how the value is displayed to the user and what processing is applied before it is passed to the script.\\ Hidden types are text token processed, but are not displayed in the editor | | + | * The same rules as Keyboard Maestro Variable Names apply. |
| + | * The label is displayed to the user and used to pass the parameter to the script. | ||
| + | * Obviously, the label must be unique amongst all parameters | ||
| + | </WRAP> | | ||
| + | ^ Type | **Type of the parameter**.\\ Must be one of the following:\\ _(Text in italics is info, and not part of the Type)_<WRAP> | ||
| + | * String _(single line)_ | ||
| + | * TokenString | ||
| + | * Calculation | ||
| + | * Text _(multi-line)_ | ||
| + | * TokenText | ||
| + | * Checkbox _(0 or 1)_ | ||
| + | * PopupMenu | ||
| + | * Hidden | ||
| + | </WRAP> The Type specifies how the value is displayed to the user and what processing is applied before it is passed to the script.\\ Hidden types are text token processed, but are not displayed in the editor | | ||
| ^ Menu | Values of the popup menu, separated by %%|%%\\ **Optional** unless Type is _PopupMenu_. | | ^ Menu | Values of the popup menu, separated by %%|%%\\ **Optional** unless Type is _PopupMenu_. | | ||
| ^ Default | Default value of the Parameter when the PIA is inserted in the Macro.\\ **Optional** | | ^ Default | Default value of the Parameter when the PIA is inserted in the Macro.\\ **Optional** | | ||
| + | |||
| + | Each parameter in the Parameters array is a dictionary with the following keys: | ||
| + | |||
| Warning: Keys are case sensitive. | Warning: Keys are case sensitive. | ||
manual/Plug_In_Actions.txt · Last modified: 2023/10/06 02:28 by peternlewis
Page Tools
