SplitContainer.ProcessDialogKey(Keys) Method

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Processes a dialog box key.

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

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

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

Protected Overrides 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 control; otherwise, false.

Remarks

This method is called during message preprocessing to handle dialog box key characters, such as TAB, LEFT ARROW, RIGHT ARROW, UP ARROW, and DOWN ARROW. Keys that include the ALT or CONTROL modifiers are not handled. This method is called only if the Control.IsInputKey method indicates that the control is not processing the key. The Control.ProcessDialogKey simply sends the character to the parent's Control.ProcessDialogKey method, or returns false if the control has no parent. The System.Windows.Forms.Form class overrides this method to perform actual processing of dialog box keys. The run time calls this method only when the control is hosted in a Windows Forms application or as an ActiveX control.

Notes to Inheritors

When overriding the ProcessDialogKey(Keys) method in a derived class, a control should return true to indicate that it has processed the key. For keys that are not processed by the control, the result of calling the base class's ProcessDialogChar(Char) method should be returned. Controls will seldom, if ever, need to override this method.

Applies to

Deila með