Export (0) Print
Expand All
Expand Minimize

Control.ProcessKeyMessage Method

Processes a keyboard message.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

[SecurityPermissionAttribute(SecurityAction.InheritanceDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
[SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
protected internal virtual bool ProcessKeyMessage(
	ref Message m
)

Parameters

m
Type: System.Windows.Forms.Message%
A Message, passed by reference, that represents the window message to process.

Return Value

Type: System.Boolean
true if the message was processed by the control; otherwise, false.

This method is called when a control receives a keyboard message. The method first determines whether the control has a parent; if so, it calls the parent's ProcessKeyPreview method. If the parent's ProcessKeyPreview method does not process the message then the ProcessKeyEventArgs method is called to generate the appropriate keyboard events. The m parameter contains the window message that must be processed. Possible values for the Message.Msg property are WM_CHAR, WM_KEYDOWN, WM_SYSKEYDOWN, WM_KEYUP, and WM_SYSKEYUP.

Notes to Inheritors

When overriding the ProcessKeyMessage method, a control should return true to indicate that it has processed the key. For keys that are not processed by the control, the result of the base class's ProcessKeyEventArgs should be returned. Controls will seldom, if ever, need to override this method.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft