This documentation is archived and is not being maintained.

IEditableCollectionView.CancelEdit Method

Ends the edit transaction and, if possible, restores the original value to the item.

Namespace:  System.ComponentModel
Assembly:  WindowsBase (in WindowsBase.dll)

void CancelEdit()

CancelEdit sets CurrentEditItem to null and causes the collection view to exit the edit state. If CanCancelEdit is true, CancelEdit also restores the original values of the edited object.

The following example gets CanCancelEdit to check whether the original values of the edited item can be restored before it calls CancelEdit. If the values cannot be restored, you must supply additional logic to do so. If they can be, the values are restored when the example calls CancelEdit. For the entire sample, see Changing a Collection by Using IEditableCollectionView Sample.


// If the objects in the collection can discard pending 
// changes, calling IEditableCollectionView.CancelEdit
// will revert the changes. Otherwise, you must provide
// your own logic to revert the changes in the object.

if (!editableCollectionView.CanCancelEdit)
{
    // Provide logic to revert changes.
}

editableCollectionView.CancelEdit();


.NET Framework

Supported in: 4, 3.5 SP1, 3.0 SP2

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, 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: