Control.ProcessDialogKey Method (System.Windows.Forms)

Switch View

ProcessDialogKey Method

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2005/.NET Framework 2.0

Other versions are also available for the following:

.NET Framework Class Library

Control.ProcessDialogKey Method

Processes a dialog key.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

Syntax

Visual Basic (Declaration)

Protected Overridable Function ProcessDialogKey ( _
    keyData As Keys _
) As Boolean

Visual Basic (Usage)

Dim keyData As Keys
Dim returnValue As Boolean

returnValue = Me.ProcessDialogKey(keyData)

protected virtual bool ProcessDialogKey (
    Keys keyData
)

C++

protected:
virtual bool ProcessDialogKey (
    Keys keyData
)

protected boolean ProcessDialogKey (
    Keys keyData
)

JScript

protected function ProcessDialogKey (
    keyData : Keys
) : boolean

Parameters

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

Return Value

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

Remarks

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.

.NET Framework Security

UIPermission for all windows for inheriting classes to call this method. Associated enumeration: AllWindows value of UIPermissionWindow.

Platforms

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Version Information

.NET Framework

Supported in: 2.0, 1.1, 1.0

Reference

Control Class
Control Members
System.Windows.Forms Namespace