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:
9.3
9.4
9.5
10.0
10.1
10.2
10.3
10.4
10.5
10.6
Statistic
FMM
Blog
HotKey.SetScript
Sets which script to call if hotkey is pressed.
| Component | Version | macOS | Windows | Linux | Server | FileMaker iOS SDK |
| HotKey | 5.0 | Yes | Yes | No | No | No |
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.
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
- HotKey.GetTag
- HotKey.Register
- HotKey.SetLocal
- HotKey.SetName
- HotKey.SetScriptWorkspaceOnly
- HotKey.SetTag
Example Databases
Release notes
- Version 10.2
- Added HotKey.SetScriptWorkspaceOnly and HotKey.GetScriptWorkspaceOnly functions.
Created 4th February 2015, last changed 19th November 2020
HotKey.SetPermanent - HotKey.SetScriptWorkspaceOnly
Feedback: Report problem or ask question.
Links
MBS Xojo PDF Plugins
