Note: This method is new in the .NET Framework version 2.0.
Puts the current cell in edit mode.
Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)
Visual Basic (Declaration)
Public Overridable Function BeginEdit ( _
selectAll As Boolean _
) As Boolean
Dim instance As DataGridView
Dim selectAll As Boolean
Dim returnValue As Boolean
returnValue = instance.BeginEdit(selectAll)
public virtual bool BeginEdit (
bool selectAll
)
public:
virtual bool BeginEdit (
bool selectAll
)
public boolean BeginEdit (
boolean selectAll
)
public function BeginEdit (
selectAll : boolean
) : boolean
Parameters
- selectAll
true to select all the cell's contents; false to not select any contents.
Return Value
true if the current cell is already in edit mode or successfully enters edit mode; otherwise, false.
This method returns false if the cell fails to enter edit mode, which can happen for a number of reasons. This method returns false if the current cell is read-only. It also returns false if the cell EditType property is a null reference (Nothing in Visual Basic) (meaning the cell cannot host an editing control) and the cell type does not implement the IDataGridViewEditingCell interface.
If the cell supports editing, this method raises the CellBeginEdit event, which can be canceled, and returns false if an event handler cancels the edit. If the edit is not canceled and the cell can host an editing control, this method initializes the control and displays it. If the initialization fails, this method returns false.
If the cell successfully enters edit mode, the IsCurrentCellInEditMode property returns true.
The following code example demonstrates the use of this method.
' 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
// 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
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.
.NET Framework
Supported in: 2.0