This documentation is archived and is not being maintained.

Control.ProcessKeyEventArgs Method

Processes a key message and generates the appropriate control events.

[Visual Basic]
Protected Overridable Function ProcessKeyEventArgs( _
   ByRef m As Message _
) As Boolean
protected virtual bool ProcessKeyEventArgs(
   ref Message m
protected: virtual bool ProcessKeyEventArgs(
 Message* m
protected function ProcessKeyEventArgs(
   m : Message
) : Boolean;


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_IMECHAR.

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.


Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

See Also

Control Class | Control Members | System.Windows.Forms Namespace