ProcessCmdKey Method
Collapse the table of content
Expand the table of content

ToolStripItem.ProcessCmdKey Method (Message, Keys)

 

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.

SecurityPermission

for the immediate caller and inheriting classes to call this method. Associated enumeration: SecurityPermissionFlag.UnmanagedCode.

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft