IDataGridViewEditingControl Interfaccia

  • Riferimento

Definizione

Spazio dei nomi:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

Definisce la funzionalità comune per i controlli contenuti nelle celle di un oggetto DataGridView.

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

Esempio

Nell'esempio di codice seguente viene fornita un'implementazione di questa interfaccia che deriva da DateTimePicker. Questo esempio fa parte di un esempio più ampio disponibile in Procedura: Ospitare controlli in Windows Forms celle 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

Commenti

Questa interfaccia viene implementata dai controlli, ad esempio DataGridViewComboBoxEditingControl e DataGridViewTextBoxEditingControl, ospitati da celle corrispondenti DataGridView , ad esempio DataGridViewComboBoxCell e DataGridViewTextBoxCell, quando sono in modalità di modifica.

I tipi di cella che possono ospitare controlli di modifica impostano la relativa EditType proprietà su un oggetto Type che rappresenta il tipo di controllo di modifica. Quando la cella entra in modalità di modifica, vengono eseguiti i passaggi seguenti:

  1. Il DataGridView controllo crea un'istanza del tipo di controllo di modifica.

  2. Il DataGridView controllo chiama il metodo cell InitializeEditingControl . È possibile eseguire l'override di questo metodo per trasferire il valore della cella al controllo di modifica.

  3. Il DataGridView controllo chiama il metodo di controllo ApplyCellStyleToEditingControl di modifica e passa lo stile corrente della cella. È possibile implementare questo metodo per inizializzare l'aspetto del controllo di modifica in modo che corrisponda all'aspetto della cella.

  4. Il DataGridView controllo chiama il metodo di controllo PrepareEditingControlForEdit di modifica. È possibile implementare questo metodo per apportare modifiche finali al controllo di modifica, ad esempio selezionando il valore del controllo.

Per altre informazioni sull'implementazione IDataGridViewEditingControldi , vedere Procedura: Ospitare controlli in Windows Forms celle di DataGridView.

I tipi di cella, ad DataGridViewCheckBoxCell esempio, forniscono un'interfaccia utente per specificare i valori senza ospitare un controllo di modifica implementare l'interfaccia IDataGridViewEditingCell . L'interfaccia utente in questo caso viene visualizzata indipendentemente dal fatto che la cella sia in modalità di modifica.

Altri tipi di cella, ad esempio DataGridViewButtonCell, forniscono un'interfaccia utente, ma non archiviano i valori specificati dall'utente. In questo caso, il tipo di cella non implementa o ospita IDataGridViewEditingCell un controllo di modifica.

Proprietà

EditingControlDataGridView

Ottiene o imposta l'oggetto DataGridView contenente la cella.
EditingControlFormattedValue

Ottiene o imposta il valore formattato della cella che deve essere modificata dall'editor.
EditingControlRowIndex

Ottiene o imposta l'indice della riga padre della cella ospitante.
EditingControlValueChanged

Ottiene o imposta un valore che indica se il valore del controllo di modifica differisce da quello della cella ospitante.
EditingPanelCursor

Ottiene il cursore utilizzato quando il puntatore del mouse è posizionato su EditingPanel ma non sul controllo di modifica.
RepositionEditingControlOnValueChange

Ottiene o imposta un valore che indica se il contenuto della cella deve essere riposizionato ogni volta che cambia il valore.

Metodi

ApplyCellStyleToEditingControl(DataGridViewCellStyle)

Modifica l'interfaccia utente del controllo in modo che sia coerente con lo stile di cella specificato.
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.
GetEditingControlFormattedValue(DataGridViewDataErrorContexts)

Recupera il valore formattato della cella.
PrepareEditingControlForEdit(Boolean)

Prepara la cella attualmente selezionata per la modifica.

Si applica a

Vedi anche