Udostępnij za pośrednictwem


IDataGridViewEditingControl Interfejs

Definicja

Definiuje typowe funkcje kontrolek hostowanych w komórkach obiektu DataGridView.

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

Przykłady

Poniższy przykład kodu zawiera implementację tego interfejsu, która pochodzi z DateTimePickerelementu . Ten przykład jest częścią większego przykładu dostępnego w temacie How to: Host Controls in Windows Forms DataGridView Cells (Instrukcje: kontrolki hosta w komórkach dataGridView).

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

Uwagi

Ten interfejs jest implementowany przez kontrolki, takie jak DataGridViewComboBoxEditingControl i DataGridViewTextBoxEditingControl, które są hostowane przez odpowiednie DataGridView komórki, takie jak DataGridViewComboBoxCell i DataGridViewTextBoxCell, gdy są w trybie edycji.

Typy komórek, które mogą hostować kontrolki edycji, ustawiają ich EditType właściwość na Type reprezentujący typ kontrolki edycji. Po wprowadzeniu trybu edycji komórki są wykonywane następujące kroki:

  1. Kontrolka DataGridView tworzy wystąpienie typu kontrolki edycji.

  2. Kontrolka DataGridView wywołuje metodę komórki InitializeEditingControl . Tę metodę można zastąpić, aby przenieść wartość komórki do kontrolki edycji.

  3. Kontrolka DataGridView wywołuje metodę kontrolki ApplyCellStyleToEditingControl edycji i przekazuje bieżący styl komórki. Tę metodę można zaimplementować w celu zainicjowania wyglądu kontrolki edycji tak, aby była zgodna z wyglądem komórki.

  4. Kontrolka DataGridView wywołuje metodę kontrolki PrepareEditingControlForEdit edycji. Tę metodę można zaimplementować, aby wprowadzić ostateczne korekty w kontrolce edycji, na przykład wybierając wartość kontrolki.

Aby uzyskać więcej informacji na temat implementowania IDataGridViewEditingControl, zobacz Instrukcje: kontrolki hosta w Windows Forms komórkach DataGridView.

Typy komórek, takie jak DataGridViewCheckBoxCell , które zapewniają interfejs użytkownika do określania wartości bez hostowania kontrolki edycji implementują IDataGridViewEditingCell interfejs. Interfejs użytkownika w tym przypadku jest wyświetlany niezależnie od tego, czy komórka jest w trybie edycji.

Inne typy komórek, takie jak DataGridViewButtonCell, zapewniają interfejs użytkownika, ale nie przechowują wartości określonych przez użytkownika. W takim przypadku typ komórki nie implementuje ani nie hostuje IDataGridViewEditingCell kontrolki edycji.

Właściwości

EditingControlDataGridView

Pobiera lub ustawia DataGridView komórkę zawierającą komórkę.

EditingControlFormattedValue

Pobiera lub ustawia sformatowaną wartość komórki zmodyfikowanej przez edytor.

EditingControlRowIndex

Pobiera lub ustawia indeks wiersza nadrzędnego komórki hostingu.

EditingControlValueChanged

Pobiera lub ustawia wartość wskazującą, czy wartość kontrolki edycji różni się od wartości komórki hostingu.

EditingPanelCursor

Pobiera kursor używany, gdy wskaźnik myszy jest nad EditingPanel kontrolką edycji, ale nie nad kontrolką edycji.

RepositionEditingControlOnValueChange

Pobiera lub ustawia wartość wskazującą, czy zawartość komórki musi być zmieniana przy każdej zmianie wartości.

Metody

ApplyCellStyleToEditingControl(DataGridViewCellStyle)

Zmienia interfejs użytkownika kontrolki tak, aby był zgodny z określonym stylem komórki.

EditingControlWantsInputKey(Keys, Boolean)

Określa, czy określony klucz jest zwykłym kluczem wejściowym, który kontrolka edycji powinna przetworzyć, czy specjalny klucz, który DataGridView powinien zostać przetworzyny.

GetEditingControlFormattedValue(DataGridViewDataErrorContexts)

Pobiera sformatowaną wartość komórki.

PrepareEditingControlForEdit(Boolean)

Przygotowuje aktualnie wybraną komórkę do edycji.

Dotyczy

Zobacz też