Export (0) Print
Expand All
Expand Minimize

ToolStripItem.ProcessCmdKey Method

Processes a command key.

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

[SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
[SecurityPermissionAttribute(SecurityAction.InheritanceDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
protected internal virtual bool ProcessCmdKey(
	ref Message m,
	Keys keyData
)

Parameters

m
Type: System.Windows.Forms.Message

A Message, passed by reference, that represents the window 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
false in all cases.

This method is called during message preprocessing to handle command keys. Command keys are keys that always take precedence over regular input keys. Examples of command keys include accelerators and menu shortcuts. The method must return true to indicate that it has processed the command key, or false to indicate that the key is not a command key.

The base-class implementation of ProcessCmdKey method returns false in all cases.

Notes to Inheritors

When overriding the ProcessCmdKey method in a derived class, the method override should return true to indicate that it has processed the key. Derived classes will seldom, if ever, need to override this method.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft