This topic has not yet been rated - Rate this topic

IEditableCollectionView.CanCancelEdit Property

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

Supported in: 4.5.1, 4.5, 4, 3.5 SP1, 3.0 SP2

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.