IDataGridViewEditingControl Interfaccia

Definizione

Definisce la funzionalità comune per i controlli contenuti nelle celle di un oggetto 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
Derivato

Esempi

Nell'esempio di codice seguente viene fornita un'implementazione di questa interfaccia che deriva DateTimePickerda.The following code example provides an implementation of this interface that derives from DateTimePicker. Questo esempio fa parte di un esempio più ampio disponibile in procedura: Controlli host in Windows Forms celleDataGridView.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

Commenti

Questa interfaccia viene implementata dai controlli, ad DataGridViewComboBoxEditingControl esempio DataGridViewTextBoxEditingControle, ospitati da celle DataGridView DataGridViewComboBoxCell corrispondenti, ad esempio e DataGridViewTextBoxCell, quando sono in modalità di modifica.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.

I tipi di cella che possono ospitare i controlli EditType di modifica impostano la proprietà su un oggetto Type che rappresenta il tipo di controllo di modificaCell types that can host editing controls set their EditType property to a Type representing the editing control type. Quando la cella entra in modalità di modifica, vengono eseguiti i passaggi seguenti:When the cell enters edit mode, the following steps are performed:

  1. Il DataGridView controllo crea un'istanza del tipo di controllo di modifica.The DataGridView control creates an instance of the editing control type.

  2. Il DataGridView controllo chiama il metodo InitializeEditingControl Cell.The DataGridView control calls the cell InitializeEditingControl method. È possibile eseguire l'override di questo metodo per trasferire il valore della cella nel controllo di modifica.You can override this method to transfer the cell value to the editing control.

  3. Il DataGridView controllo chiama il metodo del ApplyCellStyleToEditingControl controllo di modifica e passa lo stile corrente della cella.The DataGridView control calls the editing control ApplyCellStyleToEditingControl method and passes in the cell's current style. È possibile implementare questo metodo per inizializzare l'aspetto del controllo di modifica in modo che corrisponda all'aspetto della cella.You can implement this method to initialize the appearance of the editing control so that it matches the appearance of the cell.

  4. Il DataGridView controllo chiama il metodo del PrepareEditingControlForEdit controllo di modifica.The DataGridView control calls the editing control PrepareEditingControlForEdit method. È possibile implementare questo metodo per apportare le modifiche finali al controllo di modifica, ad esempio la selezione del valore del controllo.You can implement this method to make final adjustments to the editing control, such as selecting the control value.

Per ulteriori informazioni sull'implementazione IDataGridViewEditingControldi, vedere Procedura: Controlli host in Windows Forms celleDataGridView.For more information about implementing IDataGridViewEditingControl, see How to: Host Controls in Windows Forms DataGridView Cells.

I tipi DataGridViewCheckBoxCell di cella come che forniscono un'interfaccia utente per specificare i valori senza ospitare un controllo di modifica implementano IDataGridViewEditingCell l'interfaccia.Cell types such as DataGridViewCheckBoxCell that provide a user interface (UI) for specifying values without hosting an editing control implement the IDataGridViewEditingCell interface. L'interfaccia utente in questo caso viene visualizzata indipendentemente dal fatto che la cella sia in modalità di modifica.The UI in this case is displayed regardless of whether the cell is in edit mode.

Altri tipi di celle, ad DataGridViewButtonCellesempio, forniscono un'interfaccia utente, ma non archiviano i valori specificati dall'utente.Other cell types, such as DataGridViewButtonCell, provide a UI but do not store user-specified values. In questo caso, il tipo di cella non implementa IDataGridViewEditingCell né ospita un controllo di modifica.In this case, the cell type does not implement IDataGridViewEditingCell or host an editing control.

Proprietà

EditingControlDataGridView

Ottiene o imposta l'oggetto DataGridView contenente la cella.Gets or sets the DataGridView that contains the cell.

EditingControlFormattedValue

Ottiene o imposta il valore formattato della cella che deve essere modificata dall'editor.Gets or sets the formatted value of the cell being modified by the editor.

EditingControlRowIndex

Ottiene o imposta l'indice della riga padre della cella ospitante.Gets or sets the index of the hosting cell's parent row.

EditingControlValueChanged

Ottiene o imposta un valore che indica se il valore del controllo di modifica differisce da quello della cella ospitante.Gets or sets a value indicating whether the value of the editing control differs from the value of the hosting cell.

EditingPanelCursor

Ottiene il cursore utilizzato quando il puntatore del mouse è posizionato su EditingPanel ma non sul controllo di modifica.Gets the cursor used when the mouse pointer is over the EditingPanel but not over the editing control.

RepositionEditingControlOnValueChange

Ottiene o imposta un valore che indica se il contenuto della cella deve essere riposizionato ogni volta che cambia il valore.Gets or sets a value indicating whether the cell contents need to be repositioned whenever the value changes.

Metodi

ApplyCellStyleToEditingControl(DataGridViewCellStyle)

Modifica l'interfaccia utente del controllo in modo che sia coerente con lo stile di cella specificato.Changes the control's user interface (UI) to be consistent with the specified cell style.

EditingControlWantsInputKey(Keys, Boolean)

Determina se il tasto specificato è un normale tasto di input che deve essere elaborato dal controllo di modifica o un tasto speciale che deve essere elaborato da 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)

Recupera il valore formattato della cella.Retrieves the formatted value of the cell.

PrepareEditingControlForEdit(Boolean)

Prepara la cella attualmente selezionata per la modifica.Prepares the currently selected cell for editing.

Si applica a

Vedi anche