User Tools

Site Tools


token:TriggerValue

**This is an old revision of the document!**

The %TriggerValue% token returns the value associated with how the macro was triggered.

Different ways of triggering the macro will set this field differently.

  • You can pass an explicit value in using the “with parameter” option when executing a script from AppleScript.
  • You can pass an explicit value in when using the Execute a Macro action.
  • You can pass an explicit value in when executing the macro via the web server.
  • You can pass an explicit value in when executing the macro via the kmtrigger URL.

When a Macro is triggered, the The %TriggerValue% token value will be based on the trigger:

Trigger Type %TriggerValue% token
Typed String trigger The exact text you typed to trigger
Status Menu or Palette The current modifiers (Note that Option means “edit this macro instead of triggering it”).
Hot Key Trigger or USB Device Key The key that was pressed.
Application Trigger Path to the application that was triggered.
Folder Trigger Path of the file that was added or removed.
Execute a Macro action Although Execute a Macro is not technically a trigger, when a Macro is executed by this method (the “Sub-Macro”), the %TriggerValue% token (as evaluated in the “Sub-Macro”) will be either of two values:
1. The %TriggerValue% of the calling (“Main”) Macro
OR
2. The value of the Parameter of the Execute a Macro, if a Parameter is provided.

To use the %TriggerValue% token in a numeric field, use the CALCULATE function: CALCULATE(%TriggerValue%).

You can easily access the individual parts using the token array notation, eg %TriggerValue[3]% will be the third comma-separated value, and %TriggerValue[3];% will be the third semicolon-separated value, and %TriggerValue[3] % (note the space between the ] and the %) will be the third space-separated value (8.0.4+).

See Also

Tokens

token/TriggerValue.1636907707.txt.gz · Last modified: 2021/11/14 11:35 by ccstone