Specifies a shortcut key combination for a button mouseUp handler.
# Metadata
Platforms: desktop OS: mac, windows, linux Introduced: 1.0 Security:
# Syntax
set the accel[erator]Key of button to {empty | letterChar}
# Examples
set the acceleratorKey of button 1 to "a"
set the acceleratorKey of button "Switch Order" to "F8"
set the accelKey of button "Calc" to field "Key"
# Description
Use the acceleratorKey property to give users a shortcut key combination for often-used buttons, or to provide a keyboard equivalent to a button that's used as a menu item in a stack menu.
Press the key combination defined in a button's acceleratorKey property to send a mouseUp message to the button, instead of clicking.
The key(s) specified in the acceleratorModifiers property must be pressed along with the acceleratorKey.
>*Important:* The acceleratorKey property is case-sensitive. You > must specify a lowercase letter as the letterChar; the uppercase > letter is not equivalent.
If the insertion point is in a field, the keypress is sent to the field, and the button does not receive it.
On Unix systems, the key names are listed in the file "/usr/include/X11/keysymdef.h". Don't include the "XK_" prefix in these key names; for example, use "F8" for the key designated as "XK_F8" in the file.
# Tags
ui,
# See
- **keyword:** button - **property:** default, commandChar, acceleratorText - **message:** mouseUp - **object:** button - **glossary:** property, menu item, key combination, handler, stack menu, case-sensitive, keyboard equivalent