SplitContainer::ProcessDialogKey Method (Keys)

 

Processes a dialog box key.

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

protected:
[UIPermissionAttribute(SecurityAction::LinkDemand, Window = UIPermissionWindow::AllWindows)]
virtual bool ProcessDialogKey(
	Keys keyData
) override

Parameters

keyData
Type: System.Windows.Forms::Keys

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

Return Value

Type: System::Boolean

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

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 Control::ProcessDialogKey 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 Control::ProcessDialogChar method should be returned. Controls will seldom, if ever, need to override this method.

UIPermission

for all windows for inheriting classes to call this method. Associated enumeration: UIPermissionWindow::AllWindows

.NET Framework
Available since 2.0
Return to top
Show: