IDataGridViewEditingControl IDataGridViewEditingControl IDataGridViewEditingControl IDataGridViewEditingControl Interface

Определение

Определяет общие функции для элементов управления, размещенных в ячейках объекта DataGridView.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
Производный

Примеры

В следующем примере кода предоставляет реализацию этого интерфейса, который является производным от DateTimePicker.The following code example provides an implementation of this interface that derives from DateTimePicker. Этот пример является частью большего примера, доступных в как: Ведущие элементы управления в формах Windows Forms ячеек элемента управления DataGridView.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

Комментарии

Этот интерфейс реализуется элементами управления, такими как DataGridViewComboBoxEditingControl и DataGridViewTextBoxEditingControl, расположенных в соответствующий DataGridView ячейки, такие как DataGridViewComboBoxCell и DataGridViewTextBoxCell, если они находятся в режиме редактирования.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.

Ячейки типов, которые можно разместить редактирования набора элементов управления их EditType свойства Type типа, представляющий редактирования элемента управления.Cell types that can host editing controls set their EditType property to a Type representing the editing control type. Когда ячейка переходит в режим правки, выполняются следующие действия:When the cell enters edit mode, the following steps are performed:

  1. DataGridView Элемент управления создает экземпляр типа элемента управления редактирования.The DataGridView control creates an instance of the editing control type.

  2. DataGridView Элемент управления вызывает ячейки InitializeEditingControl метод.The DataGridView control calls the cell InitializeEditingControl method. Можно переопределить этот метод для передачи значения ячейки в элементе управления редактирования.You can override this method to transfer the cell value to the editing control.

  3. DataGridView Элемент управления вызывает в элементе управления редактирования ApplyCellStyleToEditingControl и передает в стиле текущей ячейки.The DataGridView control calls the editing control ApplyCellStyleToEditingControl method and passes in the cell's current style. Можно реализовать этот метод для инициализации внешнего вида элемента управления, чтобы он соответствовал внешний вид ячейки.You can implement this method to initialize the appearance of the editing control so that it matches the appearance of the cell.

  4. DataGridView Элемент управления вызывает в элементе управления редактирования PrepareEditingControlForEdit метод.The DataGridView control calls the editing control PrepareEditingControlForEdit method. Можно реализовать этот метод для выполнения окончательных настроек в элемент управления редактирования, такие как выбор этого значения элемента управления.You can implement this method to make final adjustments to the editing control, such as selecting the control value.

Дополнительные сведения о реализации IDataGridViewEditingControl, см. в разделе как: Ведущие элементы управления в формах Windows Forms ячеек элемента управления DataGridView.For more information about implementing IDataGridViewEditingControl, see How to: Host Controls in Windows Forms DataGridView Cells.

Типы, такие как ячейки DataGridViewCheckBoxCell , которые предоставляют пользовательский интерфейс (UI) для задания значений без размещения редактирования элемента управления реализуйте IDataGridViewEditingCell интерфейс.Cell types such as DataGridViewCheckBoxCell that provide a user interface (UI) for specifying values without hosting an editing control implement the IDataGridViewEditingCell interface. В этом случае пользовательский Интерфейс отображается независимо от того, находится ли ячейка в режиме редактирования.The UI in this case is displayed regardless of whether the cell is in edit mode.

Другие ячейки типы, такие как DataGridViewButtonCell, предоставляют пользовательский Интерфейс, но не храните указанные пользователем значения.Other cell types, such as DataGridViewButtonCell, provide a UI but do not store user-specified values. В этом случае тип ячейки не реализует IDataGridViewEditingCell или размещать элемент управления редактирования.In this case, the cell type does not implement IDataGridViewEditingCell or host an editing control.

Свойства

EditingControlDataGridView EditingControlDataGridView EditingControlDataGridView EditingControlDataGridView

Получает или задает объект DataGridView, содержащий ячейку.Gets or sets the DataGridView that contains the cell.

EditingControlFormattedValue EditingControlFormattedValue EditingControlFormattedValue EditingControlFormattedValue

Получает или задает форматированное значение ячейки, которая изменяется редактором.Gets or sets the formatted value of the cell being modified by the editor.

EditingControlRowIndex EditingControlRowIndex EditingControlRowIndex EditingControlRowIndex

Получает или задает индекс родительской строки принимающей ячейки.Gets or sets the index of the hosting cell's parent row.

EditingControlValueChanged EditingControlValueChanged EditingControlValueChanged EditingControlValueChanged

Получает или задает значение, указывающее, отличается ли значение элемента управления редактирования от значения принимающей ячейки.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

Получает курсор, используемый, когда указатель мыши находится над элементом EditingPanel, но вне элемента управления редактирования.Gets the cursor used when the mouse pointer is over the EditingPanel but not over the editing control.

RepositionEditingControlOnValueChange RepositionEditingControlOnValueChange RepositionEditingControlOnValueChange RepositionEditingControlOnValueChange

Получает или задает значение, указывающее, нужно ли перемещать содержимое ячейки в случае изменения ее значения.Gets or sets a value indicating whether the cell contents need to be repositioned whenever the value changes.

Методы

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

Изменяет пользовательский интерфейс элемента управления в соответствии с заданным стилем ячейки.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)

Определяет, является ли заданная клавиша обычной клавишей ввода, которая должна обрабатываться элементом управления "Поле ввода", или специальной клавишей, которая должна обрабатываться объектом DataGridView.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)

Извлекает форматированное значение ячейки.Retrieves the formatted value of the cell.

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

Подготавливает выбранную ячейку к редактированию.Prepares the currently selected cell for editing.

Применяется к

Дополнительно