Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
ProcessKeyPreview Method
Collapse the table of content
Expand the table of content

Control.ProcessKeyPreview Method

Previews a keyboard message.

[Visual Basic]
Protected Overridable Function ProcessKeyPreview( _
   ByRef m As Message _
) As Boolean
[C#]
protected virtual bool ProcessKeyPreview(
   ref Message m
);
[C++]
protected: virtual bool ProcessKeyPreview(
 Message* m
);
[JScript]
protected function ProcessKeyPreview(
   m : Message
) : Boolean;

Parameters

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

Remarks

This method is called by a child control when the child control receives a keyboard message. The child control calls this method before generating any keyboard events for the message. If this method returns true, the child control considers the message processed and does not generate any keyboard events. The m parameter contains the window message to preview. Possible values for the Message.Msg property are WM_CHAR, WM_KEYDOWN, WM_SYSKEYDOWN, WM_KEYUP, and WM_SYSKEYUP. The ProcessKeyPreview method simply sends the character to the parent's ProcessKeyPreview method, or returns false if the control has no parent. The Form class overrides this method to perform actual processing of dialog keys.

Notes to Inheritors:  When overriding the ProcessKeyPreview 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.

Requirements

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

Show:
© 2015 Microsoft