trigger userKey
Trigger for responding to user-defined key sequences as defined in the keyboard translation table.
| Declaration: | trigger userKey
|
| Applies to: | Application Shell, Form |
| Activation: | Activated in response to the ^USER_KEY
request. Uniface first tries to activate the component-level trigger. If it is empty, or returns a
value >= 0 (but not 99), the application-level trigger is
activated.The userKey trigger is not activated if the structure editor is not available, for example if it is waiting for a response to an askmess, if there is a menu active, if a panel is showing, and so on. |
| Default behavior: | None |
| Behavior upon completion: | If $status after the
component-level trigger is:
None |
Description
This trigger is used to define the processing associated with user-defined key sequences. These are defined in the keyboard translation table using the ^USER_KEY definition. The identification character for this user key sequence is available in $char. All characters between the identification character and the terminator code defined for the user key are stored in $result, provided that no more than 61 characters are entered. Characters after the sixty-first character are ignored until the defined terminator character sequence is encountered.
