This documentation is archived and is not being maintained.

Control.ProcessDialogKey Method

Processes a dialog key.

[Visual Basic]
Protected Overridable Function ProcessDialogKey( _
   ByVal keyData As Keys _
) As Boolean
protected virtual bool ProcessDialogKey(
 Keys keyData
protected: virtual bool ProcessDialogKey(
 Keys keyData
protected function ProcessDialogKey(
   keyData : Keys
) : Boolean;


One of the Keys values that represents the key to process.

Return Value

true if the key was processed by the control; otherwise, false.


This method is called during message preprocessing to handle dialog characters, such as TAB, RETURN, ESCAPE, and arrow keys. This method is called only if the IsInputKey method indicates that the control is not processing the key. The ProcessDialogKey simply sends the character to the parent's ProcessDialogKey method, or returns false if the control has no parent. The Form class overrides this method to perform actual processing of dialog keys. This method is only called when the control is hosted in a Windows Forms application or as an ActiveX control.

Notes to Inheritors:  When overriding the ProcessDialogKey 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 ProcessDialogChar 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