Control.ProcessKeyEventArgs Method (System.Windows.Forms)

.NET Framework Class Library

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)

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

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

[SecurityPermissionAttribute(SecurityAction::LinkDemand, Flags = SecurityPermissionFlag::UnmanagedCode)]
[SecurityPermissionAttribute(SecurityAction::InheritanceDemand, Flags = SecurityPermissionFlag::UnmanagedCode)]
protected:
virtual bool ProcessKeyEventArgs(
	Message% m
)

[<SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)>]
[<SecurityPermissionAttribute(SecurityAction.InheritanceDemand, Flags = SecurityPermissionFlag.UnmanagedCode)>]
abstract ProcessKeyEventArgs : 
        m:Message byref -> bool 
[<SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)>]
[<SecurityPermissionAttribute(SecurityAction.InheritanceDemand, Flags = SecurityPermissionFlag.UnmanagedCode)>]
override ProcessKeyEventArgs : 
        m:Message byref -> bool

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.

Remarks

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.

Version Information

.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

.NET Framework Security

UIPermission
for all windows for inheriting classes to call this method. Associated enumeration: AllWindows value of UIPermissionWindow.
SecurityPermission
for the immediate caller to call unmanaged code. Associated enumeration: UnmanagedCode

Platforms

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.

Reference

Control Class

System.Windows.Forms Namespace

Advertise Here