DataGridView.BeginEdit Method
Assembly: System.Windows.Forms (in system.windows.forms.dll)
| Exception type | Condition |
|---|---|
| CurrentCell is not set to a valid cell. -or- This method was called in a handler for the CellBeginEdit event. |
|
| The type indicated by the cell's EditType property does not derive from the Control type. -or- The type indicated by the cell's EditType property does not implement the IDataGridViewEditingControl interface. |
|
| Initialization of the editing cell value failed and either there is no handler for the DataError event or the handler has set the DataGridViewDataErrorEventArgs.ThrowException property to true. The exception object can typically be cast to type FormatException. |
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 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.
