IDataGridViewEditingControl Schnittstelle

Definition

Definiert gemeinsame Funktionen für Steuerelemente, die sich innerhalb von Zellen einer DataGridView befinden.

public interface class IDataGridViewEditingControl
public interface IDataGridViewEditingControl
type IDataGridViewEditingControl = interface
Public Interface IDataGridViewEditingControl
Abgeleitet

Beispiele

Das folgende Codebeispiel stellt eine Implementierung dieser Schnittstelle bereit, die von abgeleitet wird DateTimePicker. Dieses Beispiel ist Teil eines größeren Beispiels, das unter How to: Host Controls in Windows Forms DataGridView Cells verfügbar ist.

class CalendarEditingControl : DateTimePicker, IDataGridViewEditingControl
{
    DataGridView dataGridView;
    private bool valueChanged = false;
    int rowIndex;

    public CalendarEditingControl()
    {
        this.Format = DateTimePickerFormat.Short;
    }

    // Implements the IDataGridViewEditingControl.EditingControlFormattedValue 
    // property.
    public object EditingControlFormattedValue
    {
        get
        {
            return this.Value.ToShortDateString();
        }
        set
        {            
            if (value is String)
            {
                try
                {
                    // This will throw an exception of the string is 
                    // null, empty, or not in the format of a date.
                    this.Value = DateTime.Parse((String)value);
                }
                catch
                {
                    // In the case of an exception, just use the 
                    // default value so we're not left with a null
                    // value.
                    this.Value = DateTime.Now;
                }
            }
        }
    }

    // Implements the 
    // IDataGridViewEditingControl.GetEditingControlFormattedValue method.
    public object GetEditingControlFormattedValue(
        DataGridViewDataErrorContexts context)
    {
        return EditingControlFormattedValue;
    }

    // Implements the 
    // IDataGridViewEditingControl.ApplyCellStyleToEditingControl method.
    public void ApplyCellStyleToEditingControl(
        DataGridViewCellStyle dataGridViewCellStyle)
    {
        this.Font = dataGridViewCellStyle.Font;
        this.CalendarForeColor = dataGridViewCellStyle.ForeColor;
        this.CalendarMonthBackground = dataGridViewCellStyle.BackColor;
    }

    // Implements the IDataGridViewEditingControl.EditingControlRowIndex 
    // property.
    public int EditingControlRowIndex
    {
        get
        {
            return rowIndex;
        }
        set
        {
            rowIndex = value;
        }
    }

    // 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;
        }
    }

    // Implements the IDataGridViewEditingControl.PrepareEditingControlForEdit 
    // method.
    public void PrepareEditingControlForEdit(bool selectAll)
    {
        // No preparation needs to be done.
    }

    // Implements the IDataGridViewEditingControl
    // .RepositionEditingControlOnValueChange property.
    public bool RepositionEditingControlOnValueChange
    {
        get
        {
            return false;
        }
    }

    // Implements the IDataGridViewEditingControl
    // .EditingControlDataGridView property.
    public DataGridView EditingControlDataGridView
    {
        get
        {
            return dataGridView;
        }
        set
        {
            dataGridView = value;
        }
    }

    // Implements the IDataGridViewEditingControl
    // .EditingControlValueChanged property.
    public bool EditingControlValueChanged
    {
        get
        {
            return valueChanged;
        }
        set
        {
            valueChanged = value;
        }
    }

    // Implements the IDataGridViewEditingControl
    // .EditingPanelCursor property.
    public Cursor EditingPanelCursor
    {
        get
        {
            return base.Cursor;
        }
    }

    protected override void OnValueChanged(EventArgs eventargs)
    {
        // Notify the DataGridView that the contents of the cell
        // have changed.
        valueChanged = true;
        this.EditingControlDataGridView.NotifyCurrentCellDirty(true);
        base.OnValueChanged(eventargs);
    }
}
Class CalendarEditingControl
    Inherits DateTimePicker
    Implements IDataGridViewEditingControl

    Private dataGridViewControl As DataGridView
    Private valueIsChanged As Boolean = False
    Private rowIndexNum As Integer

    Public Sub New()
        Me.Format = DateTimePickerFormat.Short
    End Sub

    Public Property EditingControlFormattedValue() As Object _
        Implements IDataGridViewEditingControl.EditingControlFormattedValue

        Get
            Return Me.Value.ToShortDateString()
        End Get

        Set(ByVal value As Object)
            Try
                ' This will throw an exception of the string is 
                ' null, empty, or not in the format of a date.
                Me.Value = DateTime.Parse(CStr(value))
            Catch
                ' In the case of an exception, just use the default
                ' value so we're not left with a null value.
                Me.Value = DateTime.Now
            End Try
        End Set

    End Property

    Public Function GetEditingControlFormattedValue(ByVal context _
        As DataGridViewDataErrorContexts) As Object _
        Implements IDataGridViewEditingControl.GetEditingControlFormattedValue

        Return Me.Value.ToShortDateString()

    End Function

    Public Sub ApplyCellStyleToEditingControl(ByVal dataGridViewCellStyle As _
        DataGridViewCellStyle) _
        Implements IDataGridViewEditingControl.ApplyCellStyleToEditingControl

        Me.Font = dataGridViewCellStyle.Font
        Me.CalendarForeColor = dataGridViewCellStyle.ForeColor
        Me.CalendarMonthBackground = dataGridViewCellStyle.BackColor

    End Sub

    Public Property EditingControlRowIndex() As Integer _
        Implements IDataGridViewEditingControl.EditingControlRowIndex

        Get
            Return rowIndexNum
        End Get
        Set(ByVal value As Integer)
            rowIndexNum = value
        End Set

    End Property

    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

    Public Sub PrepareEditingControlForEdit(ByVal selectAll As Boolean) _
        Implements IDataGridViewEditingControl.PrepareEditingControlForEdit

        ' No preparation needs to be done.

    End Sub

    Public ReadOnly Property RepositionEditingControlOnValueChange() _
        As Boolean Implements _
        IDataGridViewEditingControl.RepositionEditingControlOnValueChange

        Get
            Return False
        End Get

    End Property

    Public Property EditingControlDataGridView() As DataGridView _
        Implements IDataGridViewEditingControl.EditingControlDataGridView

        Get
            Return dataGridViewControl
        End Get
        Set(ByVal value As DataGridView)
            dataGridViewControl = value
        End Set

    End Property

    Public Property EditingControlValueChanged() As Boolean _
        Implements IDataGridViewEditingControl.EditingControlValueChanged

        Get
            Return valueIsChanged
        End Get
        Set(ByVal value As Boolean)
            valueIsChanged = value
        End Set

    End Property

    Public ReadOnly Property EditingControlCursor() As Cursor _
        Implements IDataGridViewEditingControl.EditingPanelCursor

        Get
            Return MyBase.Cursor
        End Get

    End Property

    Protected Overrides Sub OnValueChanged(ByVal eventargs As EventArgs)

        ' Notify the DataGridView that the contents of the cell have changed.
        valueIsChanged = True
        Me.EditingControlDataGridView.NotifyCurrentCellDirty(True)
        MyBase.OnValueChanged(eventargs)

    End Sub

End Class

Hinweise

Diese Schnittstelle wird von Steuerelementen wie DataGridViewComboBoxEditingControl und DataGridViewTextBoxEditingControlimplementiert, die von entsprechenden DataGridView Zellen wie und DataGridViewTextBoxCellgehostet werden, DataGridViewComboBoxCell wenn sie sich im Bearbeitungsmodus befinden.

Zelltypen, die Bearbeitungssteuerelemente hosten können, legen ihre EditType Eigenschaft auf eine fest Type , die den Bearbeitungssteuerelementtyp darstellt. Wenn die Zelle in den Bearbeitungsmodus wechselt, werden die folgenden Schritte ausgeführt:

  1. Das DataGridView Steuerelement erstellt eine Instanz des Bearbeitungssteuerelementtyps.

  2. Das DataGridView -Steuerelement ruft die Cell-Methode InitializeEditingControl auf. Sie können diese Methode überschreiben, um den Zellwert an das Bearbeitungssteuerelement zu übertragen.

  3. Das DataGridView Steuerelement ruft die Bearbeitungssteuerelementmethode ApplyCellStyleToEditingControl auf und übergibt den aktuellen Stil der Zelle. Sie können diese Methode implementieren, um die Darstellung des Bearbeitungssteuerelements so zu initialisieren, dass es mit der Darstellung der Zelle übereinstimmt.

  4. Das DataGridView -Steuerelement ruft die Bearbeitungssteuerelementmethode auf PrepareEditingControlForEdit . Sie können diese Methode implementieren, um abschließende Anpassungen am Bearbeitungssteuerelement vorzunehmen, z. B. das Auswählen des Steuerelementwerts.

Weitere Informationen zur Implementierung IDataGridViewEditingControlvon finden Sie unter Vorgehensweise: Hosten von Steuerelementen in Windows Forms DataGridView Cells.

Zellentypen wie DataGridViewCheckBoxCell , die eine Benutzeroberfläche (UI) zum Angeben von Werten bereitstellen, ohne ein Bearbeitungssteuerelement zu hosten, implementieren die IDataGridViewEditingCell Schnittstelle. Die Benutzeroberfläche wird in diesem Fall unabhängig davon angezeigt, ob sich die Zelle im Bearbeitungsmodus befindet.

Andere Zelltypen, z DataGridViewButtonCell. B. , stellen eine Benutzeroberfläche bereit, speichern jedoch keine vom Benutzer angegebenen Werte. In diesem Fall implementiert IDataGridViewEditingCell oder hostt der Zelltyp kein Bearbeitungssteuerelement.

Eigenschaften

EditingControlDataGridView

Ruft die DataGridView ab, die die Zelle enthält, oder legt diese fest.

EditingControlFormattedValue

Ruft den formatierten Wert der Zelle ab, die im Editor geändert wird, oder legt diesen Wert fest.

EditingControlRowIndex

Ruft den Index der übergeordneten Zeile der besitzenden Zelle ab oder legt den Index fest.

EditingControlValueChanged

Ruft einen Wert ab, der angibt, ob sich der Wert des Bearbeitungssteuerelements vom Wert der übergeordneten Zelle unterscheidet.

EditingPanelCursor

Ruft den Cursor ab, der verwendet wird, wenn sich der Mauszeiger über dem EditingPanel, jedoch nicht über dem Bearbeitungssteuerelement befindet.

RepositionEditingControlOnValueChange

Ruft einen Wert ab, der angibt, ob der Zellinhalt bei jeder Änderung des Werts neu positioniert werden muss, oder legt diesen Wert fest.

Methoden

ApplyCellStyleToEditingControl(DataGridViewCellStyle)

Ändert die Benutzeroberfläche des Steuerelements so, dass dieses dem angegebenen Zellenstil entspricht.

EditingControlWantsInputKey(Keys, Boolean)

Bestimmt, ob es sich bei der angegebenen Taste um eine normale Eingabetaste handelt, die durch das Bearbeitungssteuerelement verarbeitet werden soll, oder ob es sich um eine besondere Taste handelt, die durch die DataGridView verarbeitet werden soll.

GetEditingControlFormattedValue(DataGridViewDataErrorContexts)

Ruft den formatierten Wert der Zelle ab.

PrepareEditingControlForEdit(Boolean)

Bereitet die derzeit ausgewählte Zelle für die Bearbeitung vor.

Gilt für:

Weitere Informationen