DataGridView.BeginEdit メソッド

.NET Framework クラス ライブラリ リファレンス

DataGridView.BeginEdit メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Overridable Function
 BeginEdit ( _
    selectAll As Boolean _
) As Boolean

Visual Basic (使用法)

Dim instance As DataGridView
Dim selectAll As Boolean
Dim returnValue As Boolean

returnValue = instance.BeginEdit(selectAll)

C#

public virtual bool BeginEdit (
    bool selectAll
)

C++

public:
virtual bool BeginEdit (
    bool selectAll
)

J#

public boolean BeginEdit (
    boolean selectAll
)

JScript

public function BeginEdit (
    selectAll : boolean
) : boolean

パラメータ

selectAll

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

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

例外

例外の種類	条件
InvalidOperationException	CurrentCell が有効なセルに設定されていません。 または CellBeginEdit イベントのハンドラで、このメソッドが呼び出されました。
InvalidCastException	セルの EditType プロパティで指定された型が、Control 型から派生していません。 または セルの EditType プロパティで指定された型が、IDataGridViewEditingControl を実装していません。
Exception	編集するセルの値を初期化できませんでした。DataError イベントのハンドラが存在しないか、ハンドラによって DataGridViewDataErrorEventArgs.ThrowException プロパティが true に設定されました。例外オブジェクトは通常、FormatException 型にキャストできます。

解説

さまざまな理由により、セルが編集モードにならない場合があります。このメソッドは、セルを編集モードに移行できなかった場合に、false を返します。現在のセルが読み取り専用の場合は、false が返されます。セルの EditType プロパティが null 参照 (Visual Basic では Nothing) (つまり、セルが編集コントロールをホストできない) の場合や、セルの型が IDataGridViewEditingCell インターフェイスを実装していない場合にも、false が返されます。

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

セルを編集モードに移行できた場合、IsCurrentCellInEditMode プロパティは true を返します。

使用例

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

Visual Basic

' 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

C#

// 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);
        }
    }
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
DataGridView クラス
DataGridView メンバ
System.Windows.Forms 名前空間
CurrentCell
EditType
Control クラス
IDataGridViewEditingControl
IDataGridViewEditingCell
CellBeginEdit
IsCurrentCellInEditMode
その他の技術情報
DataGridView コントロール (Windows フォーム)