This documentation is archived and is not being maintained.

Control.ProcessKeyMessage Method

Processes a keyboard message.

[Visual Basic]
Protected Friend Overridable Function ProcessKeyMessage( _
   ByRef m As Message _
) As Boolean
protected internal virtual bool ProcessKeyMessage(
   ref Message m
protected public: virtual bool ProcessKeyMessage(
 Message* m
protected internal function ProcessKeyMessage(
   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 first determines whether the control has a parent; if so, it calls the parent's ProcessKeyMessage method. If the parent's ProcessKeyMessage 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.


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 | KeyPress | KeyDown | KeyUp