Control.ProcessKeyMessage(Message) Method

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Processes a keyboard message.

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

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

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

Protected Friend Overridable Function ProcessKeyMessage (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 first determines whether the control has a parent; if so, it calls the parent's ProcessKeyPreview method. If the parent's ProcessKeyPreview 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(Message) 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(Message) should be returned. Controls will seldom, if ever, need to override this method.

Applies to

Share via