Using a Hot Key Control

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at Using a Hot Key Control.

Typical usage of a hot key control follows the pattern below:

The control is created. If the control is specified in a dialog box template, creation is automatic when the dialog box is created. (You should have a CHotKeyCtrl member in your dialog class that corresponds to the hot key control.) Alternatively, you can use the Create member function to create the control as a child window of any window.
If you want to set a default value for the control, call the SetHotKey member function. If you want to prohibit certain shift states, call SetRules. For controls in a dialog box, a good time to do this is in the dialog box's OnInitDialog function.
The user interacts with the control by pressing a hot key combination when the hot key control has focus. The user then somehow indicates that this task is complete, perhaps by clicking a button in the dialog box.
When your program is notified that the user has selected a hot key, it should use the member function GetHotKey to retrieve the virtual key and shift state values from the hot key control.
Once you know what key the user selected, you can set the hot key using one of the methods described in Setting a Hot Key.
If the hot key control is in a dialog box, it and the CHotKeyCtrl object will be destroyed automatically. If not, you need to ensure that both the control and the CHotKeyCtrl object are properly destroyed.

See Also