DataGridView.BeginEdit(Boolean) メソッド

定義

現在のセルを編集モードにします。

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

パラメーター

selectAll
Boolean

セルの内容をすべて選択する場合は true。内容を選択しない場合は false

戻り値

現在のセルが既に編集モードである場合、または編集モードに正常に移行できた場合は true。それ以外の場合は false

例外

CurrentCell が有効なセルに設定されていません。

- または -

このメソッドが CellBeginEdit イベントに対してハンドラーで呼び出されました。

セルの EditType プロパティによって示される型が Control 型 から派生していません。

- または -

セルの EditType プロパティによって示される型が IDataGridViewEditingControl インターフェイスを実装していません。

セル値の編集の初期化に失敗し、DataError イベントのハンドラーがないか、ハンドラーで ThrowException プロパティが true に設定されています。 通常、例外オブジェクトは型 FormatException にキャストできます。

次のコード例では、このメソッドの使用方法を示します。

// 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

注釈

このメソッドは、 false セルが編集モードに入らなかった場合に を返します。これは、さまざまな理由で発生する可能性があります。 現在のセルが false 読み取り専用の場合、このメソッドは を返します。 また、cell プロパティが (つまり、セルEditTypenull編集コントロールをホストできない) 場合に、セルの種類が インターフェイスを実装していない場合も をIDataGridViewEditingCellfalseします。

セルが編集をサポートしている場合、このメソッドはイベントを CellBeginEdit 発生させ、イベント ハンドラーが編集を取り消した場合は を返 false します。 編集が取り消されず、セルが編集コントロールをホストできる場合、このメソッドはコントロールを初期化して表示します。 初期化が失敗した場合、このメソッドは を返します false

セルが正常に編集モードに入ると、 プロパティは を IsCurrentCellInEditMode 返します true

適用対象

こちらもご覧ください