ToolStripItem.ProcessCmdKey(Message, Keys) Method

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

ToolStripItem.cs

Processes a command key.

protected public:
 virtual bool ProcessCmdKey(System::Windows::Forms::Message % m, System::Windows::Forms::Keys keyData);

protected internal virtual bool ProcessCmdKey (ref System.Windows.Forms.Message m, System.Windows.Forms.Keys keyData);

abstract member ProcessCmdKey : Message * System.Windows.Forms.Keys -> bool
override this.ProcessCmdKey : Message * System.Windows.Forms.Keys -> bool

Protected Friend Overridable Function ProcessCmdKey (ByRef m As Message, keyData As Keys) As Boolean

Parameters

m

Message

A Message, passed by reference, that represents the window message to process.

keyData

Keys

One of the Keys values that represents the key to process.

Returns

Boolean

false in all cases.

Remarks

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(Message, Keys) 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.