Partage via


IDataGridViewEditingControl Interface

Définition

Définit les fonctionnalités courantes pour les contrôles hébergés dans les cellules d'un DataGridView.

public interface class IDataGridViewEditingControl
public interface IDataGridViewEditingControl
type IDataGridViewEditingControl = interface
Public Interface IDataGridViewEditingControl
Dérivé

Exemples

L’exemple de code suivant fournit une implémentation de cette interface qui dérive de DateTimePicker. Cet exemple fait partie d’un exemple plus large disponible dans 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

Remarques

Cette interface est implémentée par des contrôles, tels que DataGridViewComboBoxEditingControl et DataGridViewTextBoxEditingControl, qui sont hébergés par des cellules correspondantes DataGridView , telles que DataGridViewComboBoxCell et DataGridViewTextBoxCell, lorsqu’elles sont en mode édition.

Les types de cellules qui peuvent héberger des contrôles d’édition définissent leur EditType propriété sur un Type représentant le type de contrôle d’édition. Lorsque la cellule passe en mode édition, les étapes suivantes sont effectuées :

  1. Le DataGridView contrôle crée une instance du type de contrôle d’édition.

  2. Le DataGridView contrôle appelle la méthode de cellule InitializeEditingControl . Vous pouvez remplacer cette méthode pour transférer la valeur de cellule vers le contrôle d’édition.

  3. Le DataGridView contrôle appelle la méthode de contrôle ApplyCellStyleToEditingControl d’édition et passe le style actuel de la cellule. Vous pouvez implémenter cette méthode pour initialiser l’apparence du contrôle d’édition afin qu’il corresponde à l’apparence de la cellule.

  4. Le DataGridView contrôle appelle la méthode de contrôle PrepareEditingControlForEdit d’édition. Vous pouvez implémenter cette méthode pour apporter des ajustements finaux au contrôle d’édition, comme la sélection de la valeur du contrôle.

Pour plus d’informations sur l’implémentation IDataGridViewEditingControlde , consultez Guide pratique pour héberger des contrôles dans Windows Forms cellules DataGridView.

Les types de cellules tels DataGridViewCheckBoxCell que qui fournissent une interface utilisateur (IU) pour spécifier des valeurs sans héberger de contrôle d’édition implémentent l’interface IDataGridViewEditingCell . Dans ce cas, l’interface utilisateur s’affiche, que la cellule soit en mode édition ou non.

D’autres types de cellules, tels que DataGridViewButtonCell, fournissent une interface utilisateur, mais ne stockent pas les valeurs spécifiées par l’utilisateur. Dans ce cas, le type de cellule n’implémente IDataGridViewEditingCell ni n’héberge un contrôle d’édition.

Propriétés

EditingControlDataGridView

Obtient ou définit le DataGridView qui contient la cellule.

EditingControlFormattedValue

Obtient ou définit la valeur mise en forme de la cellule en cours de modification par l'éditeur.

EditingControlRowIndex

Obtient ou définit l'index de la ligne parente de la cellule d'hébergement.

EditingControlValueChanged

Obtient ou définit une valeur indiquant si la valeur du contrôle d'édition diffère de la valeur de la cellule d'hébergement.

EditingPanelCursor

Obtient le curseur utilisé lorsque le pointeur de la souris se trouve sur EditingPanel mais pas sur le contrôle d'édition.

RepositionEditingControlOnValueChange

Obtient ou définit une valeur indiquant si le contenu de la cellule doit être repositionné à chaque fois que la valeur change.

Méthodes

ApplyCellStyleToEditingControl(DataGridViewCellStyle)

Modifie l'interface utilisateur du contrôle pour être qu'elle soit cohérente avec le style de cellule spécifié.

EditingControlWantsInputKey(Keys, Boolean)

Détermine si la touche spécifiée est une touche de saisie normale que le contrôle d'édition doit traiter ou une touche spéciale que le DataGridView doit traiter.

GetEditingControlFormattedValue(DataGridViewDataErrorContexts)

Récupère la valeur mise en forme de la cellule.

PrepareEditingControlForEdit(Boolean)

Prépare la cellule actuellement sélectionnée pour la modification.

S’applique à

Voir aussi