ToolStrip.ProcessDialogKey Method (System.Windows.Forms)

.NET Framework Class Library

ToolStrip..::.ProcessDialogKey Method

Processes a dialog box key.

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

<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
)

[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 key was processed by the control; otherwise, false.

Remarks

The ProcessDialogKey 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 control's ProcessDialogKey method, or returns false if the control has no parent. The System.Windows.Forms..::.Form class overrides this method to perform actual processing of dialog box keys. This method is only called when the control is hosted in a Windows Forms application or 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.

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.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

ToolStrip Class

System.Windows.Forms Namespace

Advertise Here