Form.ProcessDialogKey Method (System.Windows.Forms)

ProcessDialogKey Method

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

.NET Framework Class Library

Form..::.ProcessDialogKey Method

Processes a dialog box key.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)

Syntax

Visual Basic

<UIPermissionAttribute(SecurityAction.LinkDemand, Window := UIPermissionWindow.AllWindows)> _
Protected Overrides Function ProcessDialogKey ( _
    keyData As Keys _
) As Boolean

[UIPermissionAttribute(SecurityAction.LinkDemand, Window = UIPermissionWindow.AllWindows)]
protected override bool ProcessDialogKey(
    Keys keyData
)

Visual C++

[UIPermissionAttribute(SecurityAction::LinkDemand, Window = UIPermissionWindow::AllWindows)]
protected:
virtual bool ProcessDialogKey(
    Keys keyData
) override

[<UIPermissionAttribute(SecurityAction.LinkDemand, Window = UIPermissionWindow.AllWindows)>]
abstract ProcessDialogKey : 
        keyData:Keys -> bool 
[<UIPermissionAttribute(SecurityAction.LinkDemand, Window = UIPermissionWindow.AllWindows)>]
override ProcessDialogKey : 
        keyData:Keys -> bool

Parameters

keyData: Type: System.Windows.Forms..::.Keys
One of the Keys values that represents the key to process.

Return Value

Type: System..::.Boolean
true if the keystroke was processed and consumed by the control; otherwise, false to allow further processing.

Remarks

The ProcessDialogKey method overrides the base ContainerControl..::.ProcessDialogKey implementation to provide additional handling of the RETURN and ESCAPE keys in dialog boxes. The method performs no processing on keystrokes that include the ALT or CONTROL modifiers.

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Reference

Form Class

System.Windows.Forms Namespace

ContainerControl..::.ProcessDialogKey

ProcessDialogChar

ProcessCmdKey

ProcessMnemonic