IKeyboardInputSink.OnMnemonic(MSG, ModifierKeys) Method

Reference

Definition

Namespace:: System.Windows.Interop

Assembly:: WindowsBase.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

Boolean

true if the message was handled; otherwise, false.

Attributes: SecurityCriticalAttribute

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

Product	Versions
.NET Framework	3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9

Share via