Form.ProcessCmdKey Method (System.Windows.Forms)

ProcessCmdKey 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..::.ProcessCmdKey Method

Processes a command key.

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

Syntax

Visual Basic

<SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags := SecurityPermissionFlag.UnmanagedCode)> _
Protected Overrides Function ProcessCmdKey ( _
    ByRef msg As Message, _
    keyData As Keys _
) As Boolean

[SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
protected override bool ProcessCmdKey(
    ref Message msg,
    Keys keyData
)

Visual C++

[SecurityPermissionAttribute(SecurityAction::LinkDemand, Flags = SecurityPermissionFlag::UnmanagedCode)]
protected:
virtual bool ProcessCmdKey(
    Message% msg, 
    Keys keyData
) override

[<SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)>]
abstract ProcessCmdKey : 
        msg:Message byref * 
        keyData:Keys -> bool 
[<SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)>]
override ProcessCmdKey : 
        msg:Message byref * 
        keyData:Keys -> bool

Parameters

msg: Type: System.Windows.Forms..::.Message%
A Message, passed by reference, that represents the Win32 message to process.

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 ProcessCmdKey method overrides the base

ContainerControl..::.ProcessCmdKey implementation to provide additional handling of main menu command keys and MDI accelerators.

For information about trapping keystrokes, see "How to trap keystrokes in controls by using Visual C#" and "How to trap keystrokes in .NET controls by using Visual Basic .NET" in the Microsoft Knowledge Base at http://support.microsoft.com.

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..::.ProcessCmdKey

Message

ProcessDialogKey

ProcessCmdKey

ProcessMnemonic