DataGridView.BeginEdit(Boolean) Méthode

Définition

Met la cellule active en mode édition.

public:
 virtual bool BeginEdit(bool selectAll);
public virtual bool BeginEdit (bool selectAll);
abstract member BeginEdit : bool -> bool
override this.BeginEdit : bool -> bool
Public Overridable Function BeginEdit (selectAll As Boolean) As Boolean

Paramètres

selectAll
Boolean

true pour sélectionner le contenu de toute la cellule ; false pour ne pas sélectionner de contenu.

Retours

true si la cellule active est déjà en mode édition ou si elle entre correctement en mode édition ; sinon, false.

Exceptions

La valeur définie pour CurrentCell n’est pas une cellule valide.

- ou -

Cette méthode a été appelée dans un gestionnaire pour l’événement CellBeginEdit.

Le type indiqué par la propriété EditType de la cellule ne dérive pas du type Control.

- ou -

Le type indiqué par la propriété EditType de la cellule n’implémente pas l’interface IDataGridViewEditingControl.

L’initialisation de la valeur de la cellule d’édition a échoué et il n’existe aucun gestionnaire pour l’événement DataError ou le gestionnaire a attribué à la propriété ThrowException la valeur true. L’objet d’exception peut généralement être casté en type FormatException.

Exemples

L’exemple de code suivant illustre l’utilisation de cette méthode.

// Override OnMouseClick in a class derived from DataGridViewCell to 
// enter edit mode when the user clicks the cell. 
protected override void OnMouseClick(DataGridViewCellMouseEventArgs e)
{
    if (base.DataGridView != null)
    {
        Point point1 = base.DataGridView.CurrentCellAddress;
        if (point1.X == e.ColumnIndex &&
            point1.Y == e.RowIndex &&
            e.Button == MouseButtons.Left &&
            base.DataGridView.EditMode !=
            DataGridViewEditMode.EditProgrammatically)
        {
            base.DataGridView.BeginEdit(true);
        }
    }
}
' Override OnMouseClick in a class derived from DataGridViewCell to 
' enter edit mode when the user clicks the cell. 
Protected Overrides Sub OnMouseClick( _
    ByVal e As DataGridViewCellMouseEventArgs)

    If MyBase.DataGridView IsNot Nothing Then

        Dim point1 As Point = MyBase.DataGridView.CurrentCellAddress
        If point1.X = e.ColumnIndex And _
            point1.Y = e.RowIndex And _
            e.Button = MouseButtons.Left And _
            Not MyBase.DataGridView.EditMode = _
            DataGridViewEditMode.EditProgrammatically Then

            MyBase.DataGridView.BeginEdit(True)

        End If
    End If
End Sub

Remarques

Cette méthode retourne false si la cellule ne parvient pas à passer en mode d’édition, ce qui peut se produire pour plusieurs raisons. Cette méthode retourne false si la cellule active est en lecture seule. Elle retourne false également si la propriété cell EditType est null (ce qui signifie que la cellule ne peut pas héberger un contrôle d’édition) et si le type de cellule n’implémente pas l’interface IDataGridViewEditingCell .

Si la cellule prend en charge la modification, cette méthode déclenche l’événement CellBeginEdit , qui peut être annulé, et retourne false si un gestionnaire d’événements annule la modification. Si la modification n’est pas annulée et que la cellule peut héberger un contrôle d’édition, cette méthode initialise le contrôle et l’affiche. Si l’initialisation échoue, cette méthode retourne false.

Si la cellule passe correctement en mode d’édition, la IsCurrentCellInEditMode propriété retourne true.

S’applique à

Voir aussi