Export (0) Print
Expand All
Expand Minimize

Control.ProcessKeyEventArgs Method

Processes a key message and generates the appropriate control events.

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

'Declaration
<SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags := SecurityPermissionFlag.UnmanagedCode)> _
<SecurityPermissionAttribute(SecurityAction.InheritanceDemand, Flags := SecurityPermissionFlag.UnmanagedCode)> _
Protected Overridable Function ProcessKeyEventArgs ( _
	ByRef m As Message _
) As Boolean
'Usage
Dim m As Message 
Dim returnValue As Boolean 

returnValue = Me.ProcessKeyEventArgs(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 is responsible for generating the appropriate key events for the message by calling the OnKeyPress, OnKeyDown, or OnKeyUp methods. 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, WM_SYSKEYUP, and WM_IME_CHAR.

Notes to Inheritors:

When overriding the ProcessKeyEventArgs method in a derived class, 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 calling the base class's ProcessKeyEventArgs method should be returned. Controls will seldom, if ever, need to override this method.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

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

Community Additions

ADD
Show:
© 2014 Microsoft