Control.ProcessKeyEventArgs(Message) Method

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Processes a key message and generates the appropriate control events.

protected:
 virtual bool ProcessKeyEventArgs(System::Windows::Forms::Message % m);

protected virtual bool ProcessKeyEventArgs (ref System.Windows.Forms.Message m);

abstract member ProcessKeyEventArgs : Message -> bool
override this.ProcessKeyEventArgs : Message -> bool

Protected Overridable Function ProcessKeyEventArgs (ByRef m As Message) As Boolean

Parameters

m

Message

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

Returns

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(Message) 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(Message) method should be returned. Controls will seldom, if ever, need to override this method.