ToolStripItem.ProcessDialogKey(Keys) Method

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

ToolStripItem.cs

Processes a dialog key.

protected public:
 virtual bool ProcessDialogKey(System::Windows::Forms::Keys keyData);

protected internal virtual bool ProcessDialogKey (System.Windows.Forms.Keys keyData);

abstract member ProcessDialogKey : System.Windows.Forms.Keys -> bool
override this.ProcessDialogKey : System.Windows.Forms.Keys -> bool

Protected Friend Overridable Function ProcessDialogKey (keyData As Keys) As Boolean

Parameters

keyData

Keys

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

Returns

Boolean

true if the key was processed by the item; otherwise, false.

Remarks

This method is called during message preprocessing to handle the ENTER and SPACEBAR keys in order to raise the Click event. This method is called only if the IsInputKey method indicates that the item is not processing the key.

Notes to Inheritors

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