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)

protected virtual bool ProcessKeyEventArgs (
	ref Message m
)
protected boolean ProcessKeyEventArgs (
	/** @ref */ Message m
)
JScript does not support passing value-type arguments by reference.

Parameters

m

A Message, passed by reference, that represents the window message to process.

Return Value

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 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft