IEditableCollectionView.CanCancelEdit Property

 
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.

Gets a value that indicates whether the collection view can discard pending changes and restore the original values of an edited object.

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

bool CanCancelEdit { get; }

Property Value

Type: System.Boolean

true if the collection view can discard pending changes and restore the original values of an edited object; otherwise, false.

CanCancelEdit is true if the view supports the notion of "pending changes" on the currently edited item. For example, a collection view might return true if the edited item implements IEditableObject, or if the view has information about the item's state that it can use to roll back changes. CanCancelEdit is false if the view cannot revert changes on an object. In that case, call CancelEdit to cause the view to exit the edit state and provide logic to revert the changes on the object that was edited.

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: