IEditableCollectionView.CancelEdit Method ()

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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
Available since 3.0
Silverlight
Available since 3.0
Windows Phone Silverlight
Available since 7.1
Return to top
Show: