IKeyboardInputSink.OnMnemonic Method (MSG, ModifierKeys)

.NET Framework (current version)

Note
The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

Namespace: System.Windows.Interop
Assembly: WindowsBase (in WindowsBase.dll)

Syntax

C++

[SecurityCriticalAttribute]
[UIPermissionAttribute(SecurityAction.LinkDemand, Unrestricted = true)]
bool OnMnemonic(
	ref MSG msg,
	ModifierKeys modifiers
)

Parameters

msg: Type: System.Windows.Interop.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: Type: System.Windows.Input.ModifierKeys
Modifier keys.

Return Value

Type: System.Boolean

true if the message was handled; otherwise, false.

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.

Version Information

.NET Framework
Available since 3.0