Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 10.1   10.2   10.3   10.4   10.5   11.0   11.1   11.2   11.3   11.4    Statistic    FMM    Blog  

HotKey.SetScript

Sets which script to call if hotkey is pressed.

Component Version macOS Windows Linux Server iOS SDK
HotKey 5.0 ✅ Yes ✅ Yes ❌ No ❌ No ❌ No
MBS( "HotKey.SetScript"; HotKeyRef; Filename; ScriptName )   More

Parameters

Parameter Description Example
HotKeyRef The reference value for the hotkey as returned by HotKey.Register function. $hotkey
Filename The database file name where the script is located. "test.fmp12"
ScriptName The script name. "MyScript"

Result

Returns OK or error.

Description

Sets which script to call if hotkey is pressed.
Parameter passed to the script is the HotKey reference number.
Use HotKey.GetTag to query a tag value if needed.


With plugin version 6.0 or newer the script name can be a script ID number. In that case the plugin queries the script name for the given script ID. This allows to call scripts by ID and avoid problems if scripts are later renamed.

FileMaker 19.2 adds a fmplugin extended privileges. You my need to add such an extended privileges to allow the plugin to trigger scripts. See FileMaker product documentation for details.

Examples

Register Control-F5:

Set Field [HotKeys::HotKey ID; MBS("HotKey.Register"; "F5"; "control")]
Set Variable [$r; Value:MBS("HotKey.SetScript"; HotKeys::HotKey ID; Get(FileName); "HotkeyAction")]

See also

Release notes

Example Databases

Created 4th February 2015, last changed 19th November 2020


HotKey.SetPermanent - HotKey.SetScriptWorkspaceOnly

Feedback: Report problem or ask question.