IKeyboardInputSink.OnMnemonic(MSG, ModifierKeys) Method

Definition

Called when one of the mnemonics (access keys) for this sink is invoked.

public:
 bool OnMnemonic(System::Windows::Interop::MSG % msg, System::Windows::Input::ModifierKeys modifiers);
[System.Security.SecurityCritical]
public bool OnMnemonic (ref System.Windows.Interop.MSG msg, System.Windows.Input.ModifierKeys modifiers);
public bool OnMnemonic (ref System.Windows.Interop.MSG msg, System.Windows.Input.ModifierKeys modifiers);
[<System.Security.SecurityCritical>]
abstract member OnMnemonic : MSG * System.Windows.Input.ModifierKeys -> bool
abstract member OnMnemonic : MSG * System.Windows.Input.ModifierKeys -> bool
Public Function OnMnemonic (ByRef msg As MSG, modifiers As ModifierKeys) As Boolean

Parameters

msg
MSG

The message for the mnemonic and associated data. Do not modify this message structure. It is passed by reference for performance reasons only.

modifiers
ModifierKeys

Modifier keys.

Returns

true if the message was handled; otherwise, false.

Attributes

Remarks

The Microsoft Windows message must be WM_CHAR, WM_SYSCHAR, WM_DEADCHAR or WM_SYSDEADCHAR.

If the component has contained components, the message must be passed in your implementation by calling each contained component's OnMnemonic method.

An interface that returns true from TranslateAccelerator will not call OnMnemonic. Implementations can choose to perform all specific key combination handling in TranslateChar.and bypass OnMnemonic.

Applies to

See also