IDataGridViewEditingControl IDataGridViewEditingControl IDataGridViewEditingControl IDataGridViewEditingControl Interface

Definition

Definiert gemeinsame Funktionen für Steuerelemente, die sich innerhalb von Zellen einer DataGridView befinden.Defines common functionality for controls that are hosted within cells of a DataGridView.

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

Beispiele

Im folgenden Codebeispiel wird eine Implementierung dieser Schnittstelle bereitstellt, DateTimePickerdie von abgeleitet wird.The following code example provides an implementation of this interface that derives from DateTimePicker. Dieses Beispiel ist Teil eines größeren Beispiels, das unter Vorgehensweise: Host Steuerelemente in Windows Forms DataGridView-Zellen.This example is part of a larger example available in How to: Host Controls in Windows Forms DataGridView Cells.

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 implementiert, DataGridViewComboBoxEditingControl z DataGridViewTextBoxEditingControl. b. und, die DataGridView von DataGridViewComboBoxCell entsprechenden Zellen gehostet werden DataGridViewTextBoxCell, z. b. und, wenn Sie sich im Bearbeitungsmodus befinden.This interface is implemented by controls, such as DataGridViewComboBoxEditingControl and DataGridViewTextBoxEditingControl, that are hosted by corresponding DataGridView cells, such as DataGridViewComboBoxCell and DataGridViewTextBoxCell, when they are in edit mode.

Zelltypen, die Bearbeitungs Steuerelemente hosten EditType können Type , legen ihre-Eigenschaft auf festCell types that can host editing controls set their EditType property to a Type representing the editing control type. Wenn die Zelle in den Bearbeitungsmodus wechselt, werden die folgenden Schritte ausgeführt:When the cell enters edit mode, the following steps are performed:

  1. Das DataGridView -Steuerelement erstellt eine Instanz des Steuerelement Typs "Bearbeitung".The DataGridView control creates an instance of the editing control type.

  2. Das DataGridView -Steuerelement ruft InitializeEditingControl die Cell-Methode auf.The DataGridView control calls the cell InitializeEditingControl method. Sie können diese Methode überschreiben, um den Zellwert in das Bearbeitungs Steuerelement zu übertragen.You can override this method to transfer the cell value to the editing control.

  3. Das DataGridView -Steuerelement ruft die ApplyCellStyleToEditingControl Bearbeitungs Steuerelement Methode auf und übergibt den aktuellen Stil der Zelle.The DataGridView control calls the editing control ApplyCellStyleToEditingControl method and passes in the cell's current style. Sie können diese Methode implementieren, um die Darstellung des Bearbeitungs Steuer Elements zu initialisieren, sodass es mit der Darstellung der Zelle übereinstimmt.You can implement this method to initialize the appearance of the editing control so that it matches the appearance of the cell.

  4. Das DataGridView -Steuerelement ruft die PrepareEditingControlForEdit Bearbeitungs Steuerelement Methode auf.The DataGridView control calls the editing control PrepareEditingControlForEdit method. Sie können diese Methode implementieren, um abschließende Anpassungen an dem Bearbeitungs Steuerelement vorzunehmen, z. b. die Auswahl des Steuer Elements.You can implement this method to make final adjustments to the editing control, such as selecting the control value.

Weitere Informationen zum Implementieren IDataGridViewEditingControlvon finden Sie unter Gewusst wie: Host Steuerelemente in Windows Forms DataGridView-Zellen.For more information about implementing IDataGridViewEditingControl, see How to: Host Controls in Windows Forms DataGridView Cells.

Zelltypen wie z DataGridViewCheckBoxCell . b., die eine Benutzeroberfläche zum Angeben von Werten bereitstellen, ohne ein Bearbeitungs IDataGridViewEditingCell Steuerelement zu erstellen, implementieren die-Schnittstelle.Cell types such as DataGridViewCheckBoxCell that provide a user interface (UI) for specifying values without hosting an editing control implement the IDataGridViewEditingCell interface. Die Benutzeroberfläche wird in diesem Fall angezeigt, unabhängig davon, ob sich die Zelle im Bearbeitungsmodus befindet.The UI in this case is displayed regardless of whether the cell is in edit mode.

Andere Zelltypen, wie z DataGridViewButtonCell. b., stellen eine Benutzeroberfläche bereit, speichern jedoch keine benutzerdefinierten Werte.Other cell types, such as DataGridViewButtonCell, provide a UI but do not store user-specified values. In diesem Fall implementiert IDataGridViewEditingCell oder hostet der Zellentyp kein Bearbeitungs Steuerelement.In this case, the cell type does not implement IDataGridViewEditingCell or host an editing control.

Eigenschaften

EditingControlDataGridView EditingControlDataGridView EditingControlDataGridView EditingControlDataGridView

Ruft die DataGridView ab, die die Zelle enthält, oder legt diese fest.Gets or sets the DataGridView that contains the cell.

EditingControlFormattedValue EditingControlFormattedValue EditingControlFormattedValue EditingControlFormattedValue

Ruft den formatierten Wert der Zelle ab, die im Editor geändert wird, oder legt diesen Wert fest.Gets or sets the formatted value of the cell being modified by the editor.

EditingControlRowIndex EditingControlRowIndex EditingControlRowIndex EditingControlRowIndex

Ruft den Index der übergeordneten Zeile der besitzenden Zelle ab oder legt den Index fest.Gets or sets the index of the hosting cell's parent row.

EditingControlValueChanged EditingControlValueChanged EditingControlValueChanged EditingControlValueChanged

Ruft einen Wert ab, der angibt, ob sich der Wert des Bearbeitungssteuerelements vom Wert der übergeordneten Zelle unterscheidet.Gets or sets a value indicating whether the value of the editing control differs from the value of the hosting cell.

EditingPanelCursor EditingPanelCursor EditingPanelCursor EditingPanelCursor

Ruft den Cursor ab, der verwendet wird, wenn sich der Mauszeiger über dem EditingPanel, jedoch nicht über dem Bearbeitungssteuerelement befindet.Gets the cursor used when the mouse pointer is over the EditingPanel but not over the editing control.

RepositionEditingControlOnValueChange RepositionEditingControlOnValueChange RepositionEditingControlOnValueChange RepositionEditingControlOnValueChange

Ruft einen Wert ab, der angibt, ob der Zellinhalt bei jeder Änderung des Werts neu positioniert werden muss, oder legt diesen Wert fest.Gets or sets a value indicating whether the cell contents need to be repositioned whenever the value changes.

Methoden

ApplyCellStyleToEditingControl(DataGridViewCellStyle) ApplyCellStyleToEditingControl(DataGridViewCellStyle) ApplyCellStyleToEditingControl(DataGridViewCellStyle) ApplyCellStyleToEditingControl(DataGridViewCellStyle)

Ändert die Benutzeroberfläche des Steuerelements so, dass dieses dem angegebenen Zellenstil entspricht.Changes the control's user interface (UI) to be consistent with the specified cell style.

EditingControlWantsInputKey(Keys, Boolean) EditingControlWantsInputKey(Keys, Boolean) EditingControlWantsInputKey(Keys, Boolean) 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.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.

GetEditingControlFormattedValue(DataGridViewDataErrorContexts) GetEditingControlFormattedValue(DataGridViewDataErrorContexts) GetEditingControlFormattedValue(DataGridViewDataErrorContexts) GetEditingControlFormattedValue(DataGridViewDataErrorContexts)

Ruft den formatierten Wert der Zelle ab.Retrieves the formatted value of the cell.

PrepareEditingControlForEdit(Boolean) PrepareEditingControlForEdit(Boolean) PrepareEditingControlForEdit(Boolean) PrepareEditingControlForEdit(Boolean)

Bereitet die derzeit ausgewählte Zelle für die Bearbeitung vor.Prepares the currently selected cell for editing.

Gilt für:

Siehe auch