Редагувати

Поділитися через

IDataGridViewEditingControl.EditingControlWantsInputKey(Keys, Boolean) Method

  • Reference

Definition

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll
Source:
DataGridViewEditingControl.cs
Source:
DataGridViewEditingControl.cs
Source:
IDataGridViewEditingControl.cs

Determines whether the specified key is a regular input key that the editing control should process or a special key that the DataGridView should process.

public:
 bool EditingControlWantsInputKey(System::Windows::Forms::Keys keyData, bool dataGridViewWantsInputKey);
public bool EditingControlWantsInputKey (System.Windows.Forms.Keys keyData, bool dataGridViewWantsInputKey);
abstract member EditingControlWantsInputKey : System.Windows.Forms.Keys * bool -> bool
Public Function EditingControlWantsInputKey (keyData As Keys, dataGridViewWantsInputKey As Boolean) As Boolean

Parameters

keyData
Keys

A Keys that represents the key that was pressed.

dataGridViewWantsInputKey
Boolean

true when the DataGridView wants to process the Keys in keyData; otherwise, false.

Returns

Boolean

true if the specified key is a regular input key that should be handled by the editing control; otherwise, false.

Examples

The following code example provides an implementation of this member. This example is part of a larger example available in How to: Host Controls in Windows Forms DataGridView Cells.

// Implements the IDataGridViewEditingControl.EditingControlWantsInputKey 
// method.
public bool EditingControlWantsInputKey(
    Keys key, bool dataGridViewWantsInputKey)
{
    // Let the DateTimePicker handle the keys listed.
    switch (key & Keys.KeyCode)
    {
        case Keys.Left:
        case Keys.Up:
        case Keys.Down:
        case Keys.Right:
        case Keys.Home:
        case Keys.End:
        case Keys.PageDown:
        case Keys.PageUp:
            return true;
        default:
            return !dataGridViewWantsInputKey;
    }
}

Public Function EditingControlWantsInputKey(ByVal key As Keys, _
    ByVal dataGridViewWantsInputKey As Boolean) As Boolean _
    Implements IDataGridViewEditingControl.EditingControlWantsInputKey

    ' Let the DateTimePicker handle the keys listed.
    Select Case key And Keys.KeyCode
        Case Keys.Left, Keys.Up, Keys.Down, Keys.Right, _
            Keys.Home, Keys.End, Keys.PageDown, Keys.PageUp

            Return True

        Case Else
            Return Not dataGridViewWantsInputKey
    End Select

End Function

Remarks

An editing control implements this method to determine which input keys should be processed by the control, and which input keys should be processed by the DataGridView.

The EditingControlWantsInputKey method is called by the DataGridView. The DataGridView will pass in true for dataGridViewWantsInputKey when it can process the keyData. If the editing control can let the DataGridView handle the keyData, EditingControlWantsInputKey should return false when dataGridViewWantsInputKey is true. Other implementations of EditingControlWantsInputKey may ignore a dataGridViewWantsInputKey value of true and handle the keyData in the editing control.

Applies to

See also