• Article

DataGrid.CancelEdit Method (DataGridEditingUnit)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Causes the data grid to cancel the current edit, restore the original value, and exit editing mode.

Namespace:  System.Windows.Controls
Assembly:  System.Windows.Controls.Data (in System.Windows.Controls.Data.dll)

Syntax

'Declaration
Public Function CancelEdit ( _
    editingUnit As DataGridEditingUnit _
) As Boolean

public bool CancelEdit(
    DataGridEditingUnit editingUnit
)

Parameters

Return Value

Type: System.Boolean
true if the operation was successful; otherwise, false.

Remarks

By default, you can edit items directly in the DataGrid. You manually cancel a cell edit by pressing ESC one time, and cancel all edits in a row by pressing ESC two times. To guarantee that edits can be committed and canceled correctly, the objects in the DataGrid must implement the IEditableObject interface. Alternatively, you can set the IsReadOnly property to true to disable editing in the DataGrid.

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.