OnObjectKeystroke
Performs a script when an object is active and receives one or more characters from the keyboard, either directly or via an input method editor (IME). Use the
Get(TriggerKeystroke) function to return the characters that activated the script trigger.
When the script runs
Before the event has been processed.
Modes in which the trigger can be used
Browse and Find modes.
Result
You can use the
Exit Script script step within the triggered script to return True or False.
•True: The event that triggered the script proceeds.
•False: The event that triggered the script is canceled.
Compatibility
Where the script trigger is activated | Supported |
FileMaker Pro | Yes |
FileMaker Server | No |
FileMaker Go | Yes |
Custom Web Publishing | No |
FileMaker WebDirect | No |
Runtime solution | Yes |
Originated in
FileMaker Pro 10.0
Notes
•Combining keystrokes in an IME will not activate this trigger. Instead, the trigger activates after the text is committed in the IME. The triggered script processes the committed string.
•Use the
Get(TriggerModifierKeys),
Code, and
Char functions to work with special characters such as navigational keys like the Tab and the arrow keys, and with general Unicode characters. See the Code function for a list of navigational keys and the codes reported to a script. The Char function returns the characters for Unicode code points.
•Keystrokes are processed in the following order:
1. The operating system processes certain keys.
2. FileMaker Pro processes keyboard shortcut keys.
3. A script triggered by OnObjectKeystroke processes the characters.
5. Navigational keys are used for navigation, while non-navigational keys are processed by the active object if there is one.
6. If there is no active object, an alert displays for non-navigational keys.
The first of these steps to use the key stops the process. A script executed by the OnObjectKeystroke or OnLayoutKeystroke script trigger can stop further processing of the keystroke by returning False.
•Keyboard shortcuts such as cut and paste actions (Windows: Ctrl-X, Ctrl-V; OS X: Command-X, Command-V) will not activate this script trigger.
•Using the arrow keys or mouse to navigate and select within pop-up lists, menus, and calendars will not activate this trigger. Entering text into these fields will activate this trigger.
•The OnObjectKeystroke and OnLayoutKeystroke script triggers do not activate if the active object is a
web viewer.
•The
OnObjectEnter,
OnObjectExit, and OnObjectKeystroke script triggers can be activated when assigned to summary and calculation fields.
Related topics