Component: HotKey 
------------------

Hotkeys to execute scripts.

| Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|
| [5.0](newinversion50.md "First functions introduced with version 5.0.") / [16.0](newinversion160.md "Newest functions in version 16.0.") | ✅ Yes | ✅ 79% | ❌ No | ❌ No | ❌ No |

  
| Item | Details |
|:--|:--|
| [HotKey.GetEnabled](HotKeyGetEnabled.md)   Queries the enabled state. | Mac/Win   5.4 |
| [HotKey.GetEvaluate](HotKeyGetEvaluate.md)   Queries expression to be run when hotkey is pressed. | Mac/Win   6.1 |
| [HotKey.GetFileMakerWindowOnly](HotKeyGetFileMakerWindowOnly.md)   Whether to only run the hotkey when a FileMaker document window is frontmost. | Mac/Win   16.0 |
| [HotKey.GetIgnoreOnModal](HotKeyGetIgnoreOnModal.md)   Queries state for modal dialogs. | Mac/Win   5.4 |
| [HotKey.GetKeyCode](HotKeyGetKeyCode.md)   Returns the key code given at registration. | Mac/Win   5.2 |
| [HotKey.GetKeyUp](HotKeyGetKeyUp.md)   Queries whether to trigger script both on key down and key up. | Mac only   7.1 |
| [HotKey.GetLocal](HotKeyGetLocal.md)   Queries the local flag. | Mac/Win   5.4 |
| [HotKey.GetModifiers](HotKeyGetModifiers.md)   Returns the modifiers given at registration. | Mac/Win   5.2 |
| [HotKey.GetName](HotKeyGetName.md)   Queries the name defined for this hotkey. | Mac/Win   5.4 |
| [HotKey.GetPermanent](HotKeyGetPermanent.md)   Queries whether this hotkey should be permanent. | Mac only   10.2 |
| [HotKey.GetScriptFileName](HotKeyGetScriptFileName.md)   Queries filename of script to call in case of event. | Mac/Win   5.0 |
| [HotKey.GetScriptName](HotKeyGetScriptName.md)   Queries name of script to call in case of event. | Mac/Win   5.0 |
| [HotKey.GetScriptWorkspaceOnly](HotKeyGetScriptWorkspaceOnly.md)   Queries whether this should be limited to Script Workspace. | Mac only   10.2 |
| [HotKey.GetTag](HotKeyGetTag.md)   Queries the tag defined for this hotkey. | Mac/Win   5.4 |
| [HotKey.List](HotKeyList.md)   Lists all hotkeys. | Mac/Win   5.2 |
| [HotKey.Register](HotKeyRegister.md)   Registers a global hot key based on the virtual key code and modifiers. | Mac/Win   5.0 |
| [HotKey.SetEnabled](HotKeySetEnabled.md)   Sets the enabled state. | Mac/Win   5.4 |
| [HotKey.SetEvaluate](HotKeySetEvaluate.md)   Sets expression to be run when hotkey is pressed. | Mac/Win   6.1 |
| [HotKey.SetFileMakerWindowOnly](HotKeySetFileMakerWindowOnly.md)   Set whether to only run the hotkey when a FileMaker document window is frontmost. | Mac/Win   16.0 |
| [HotKey.SetIgnoreOnModal](HotKeySetIgnoreOnModal.md)   Sets state for modal dialogs. | Mac/Win   5.4 |
| [HotKey.SetKeyUp](HotKeySetKeyUp.md)   Whether to trigger script both on key down and key up. | Mac only   7.1 |
| [HotKey.SetLocal](HotKeySetLocal.md)   Sets the local flag. | Mac/Win   5.4 |
| [HotKey.SetName](HotKeySetName.md)   Sets the name of a hotkey. | Mac/Win   5.4 |
| [HotKey.SetPermanent](HotKeySetPermanent.md)   Sets whether this hotkey should be permanent. | Mac only   10.2 |
| [HotKey.SetScript](HotKeySetScript.md)   Sets which script to call if hotkey is pressed. | Mac/Win   5.0 |
| [HotKey.SetScriptWorkspaceOnly](HotKeySetScriptWorkspaceOnly.md)   Sets whether this should be limited to Script Workspace. | Mac only   10.2 |
| [HotKey.SetTag](HotKeySetTag.md)   Sets the tag of a hotkey. | Mac/Win   5.4 |
| [HotKey.Unregister](HotKeyUnregister.md)   Unregisters a hotkey and frees resources. | Mac/Win   5.0 |
| [HotKey.UnregisterAll](HotKeyUnregisterAll.md)   Unregisters all hotkeys. | Mac/Win   10.3 |

29 functions shown.

These functions require a license (66%).

### Release notes

- **Version 16.0**
    - Added [HotKey.SetFileMakerWindowOnly](https://www.mbsplugins.eu/HotKeySetFileMakerWindowOnly.shtml) and [HotKey.GetFileMakerWindowOnly](https://www.mbsplugins.eu/HotKeyGetFileMakerWindowOnly.shtml) functions to only run hotkey when a FileMaker document window is frontmost.
- **Version 13.1**
    - Implemented local Hotkeys for Windows. So if [HotKey.Register](https://www.mbsplugins.eu/HotKeyRegister.shtml) is passed Local = 1, we run a different code path to monitor keyboard instead of registering global hotkey.
- **Version 12.1**
    - Added parameter as optional parameter for [HotKey.SetScript](https://www.mbsplugins.eu/HotKeySetScript.shtml) function to overwrite default parameter.
- **Version 11.5**
    - Changed implementation for [HotKey](https://www.mbsplugins.eu/component_HotKey.shtml) functions for local hotkeys on macOS. Now hotkey set with [HotKey.SetLocal](https://www.mbsplugins.eu/HotKeySetLocal.shtml) to 1 will now process only within FileMaker and no longer block shortcuts in other applications.
- **Version 10.4**
    - Rewrote [Hotkey](https://www.mbsplugins.eu/component_HotKey.shtml) functions for Windows to use official API. May prevent from duplicate registration and a hotkey processed in FileMaker is no longer passed to other apps.
- **Version 10.3**
    - Added [HotKey.UnregisterAll](https://www.mbsplugins.eu/HotKeyUnregisterAll.shtml) function.
    - Changed [HotKey.Unregister](https://www.mbsplugins.eu/HotKeyUnregister.shtml) function to take list of reference numbers.
- **Version 10.2**
    - Added [HotKey.SetPermanent](https://www.mbsplugins.eu/HotKeySetPermanent.shtml) and [HotKey.GetPermanent](https://www.mbsplugins.eu/HotKeyGetPermanent.shtml) functions.
    - Added [HotKey.SetScriptWorkspaceOnly](https://www.mbsplugins.eu/HotKeySetScriptWorkspaceOnly.shtml) and [HotKey.GetScriptWorkspaceOnly](https://www.mbsplugins.eu/HotKeyGetScriptWorkspaceOnly.shtml) functions.
- **Version 7.1**
    - Added [HotKey.GetKeyUp](http://www.mbsplugins.eu/HotKeyGetKeyUp.shtml) and [HotKey.SetKeyUp](http://www.mbsplugins.eu/HotKeySetKeyUp.shtml).

### Blog Entries

- [MBS @ FMTraining.TV - 25 Ways to Improve Your Database Using the FileMaker MonkeyBread Plug-in - Day 3](https://www.mbsplugins.de/archive/2025-01-24/MBS_@_FMTrainingTV_-_25_Ways_t/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Advent calendar - Door 19 - Hot Keys](https://www.mbsplugins.de/archive/2024-12-19/MBS_FileMaker_Advent_calendar_/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 14.0 for Claris FileMaker](https://www.mbsplugins.de/archive/2024-01-16/MBS_FileMaker_Plugin_140_for_C/monkeybreadsoftware_blog_filemaker)
- [Search scripts in FileMaker for Windows](https://www.mbsplugins.de/archive/2023-12-20/Search_scripts_in_FileMaker_fo/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 11.5](https://www.mbsplugins.de/archive/2021-11-16/MBS_FileMaker_Plugin_115/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 10.4 - More than 6300 Functions In One Plugin](https://www.mbsplugins.de/archive/2020-09-15/MBS_FileMaker_Plugin_104_-_Mor/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 10.2 - More than 6200 Functions In One Plugin](https://www.mbsplugins.de/archive/2020-05-12/MBS_FileMaker_Plugin_102_-_Mor/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 7.1 - More than 4400 Functions In One Plugin](https://www.mbsplugins.de/archive/2017-03-14/MBS_FileMaker_Plugin_71_-_More/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plug-in 6.1 for OS X/Windows](https://www.mbsplugins.de/archive/2016-03-08/MBS_FileMaker_Plug-in_61_for_O/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 5.2 for OS X/Windows - More than 3200 Functions](https://www.mbsplugins.de/archive/2015-08-04/MBS_FileMaker_Plugin_52_for_OS/monkeybreadsoftware_blog_filemaker)

### FileMaker Magazin

- [Ausgabe 1/2026, Seite 9](https://filemaker-magazin.de/neuigkeit/4312-Die-neue-Ausgabe-FMM_202601-steht-online)
- [Ausgabe 1/2026, Seite 10](https://filemaker-magazin.de/neuigkeit/4312-Die-neue-Ausgabe-FMM_202601-steht-online)
- [Ausgabe 6/2020, Seite 29](https://filemaker-magazin.de/neuigkeit/4118-Appetithappen-FMM_202006)

### Example Databases

- [HotKeys](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/HotKeys.shtml#2ScriptAnchor_)
- [Win Only/Search Scripts](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Win%20Only/Search%20Scripts.shtml#1ScriptAnchor_)
- [Win Only/Snippets for Windows](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Win%20Only/Snippets%20for%20Windows.shtml#2ScriptAnchor_)
- [Window/Popover CardWindow](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Window/Popover%20CardWindow.shtml#1ScriptAnchor_)

[HTML Version](component_HotKey.shtml)