IEditableCollectionView.CancelEdit Method

Definition

Namespace:

System.ComponentModel

Assembly:

WindowsBase.dll

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

public:
 void CancelEdit();

public void CancelEdit ();

abstract member CancelEdit : unit -> unit

Public Sub CancelEdit ()

Examples

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();

' 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 Not editableCollectionView.CanCancelEdit Then
    ' Provide logic to revert changes.
End If

editableCollectionView.CancelEdit()

Remarks

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.