This documentation is archived and is not being maintained.

DataGrid.EndEdit Method

Requests an end to an edit operation taking place on the System.Windows.Forms.DataGrid control.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public bool EndEdit(
	DataGridColumnStyle gridColumn,
	int rowNumber,
	bool shouldAbort
)

Parameters

gridColumn
Type: System.Windows.Forms.DataGridColumnStyle
The DataGridColumnStyle to cease editing.
rowNumber
Type: System.Int32
The number of the row to cease editing.
shouldAbort
Type: System.Boolean
Set to true if the current operation should be stopped.

Return Value

Type: System.Boolean
true if the editing operation ceases; otherwise, false.

Implements

IDataGridEditingService.EndEdit(DataGridColumnStyle, Int32, Boolean)

The EndEdit method returns false if the user is not editing (typing into) a cell.

The following code example uses the BeginEdit and EndEdit methods to edit a value in a grid displayed by the System.Windows.Forms.DataGrid control.


private void EditValue()
{ 
   int rowtoedit = 1;
   CurrencyManager myCurrencyManager = 
   (CurrencyManager)this.BindingContext[ds.Tables["Suppliers"]];
   myCurrencyManager.Position=rowtoedit;
   DataGridColumnStyle dgc = dataGrid1.TableStyles[0].GridColumnStyles[0];
   dataGrid1.BeginEdit(dgc, rowtoedit);
   // Insert code to edit the value.
   dataGrid1.EndEdit(dgc, rowtoedit, false);
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: