CancelUndo Method

Summary

Cancels the undo node started in this AnnAutomation object.

Syntax

C++

public virtual void CancelUndo()

  
Public Overridable Sub CancelUndo()

public: 
virtual void CancelUndo();

Remarks

Use this method along with the BeginUndo and EndUndo methods to programmatically add a node to the undo stack maintained by this AnnAutomation object. Typically, you add an undo node as follows:

Call the BeginUndo method before you make any changes to create a new node.
Perform any changes to the AnnAutomation object.
Call the EndUndo method to commit this undo node into the undo stack of the AnnAutomation object.
In case of errors (typically in a catch statement), call the CancelUndo method to remove the node and cancel the operation.

You do not need to manually call the BeginUndo, EndUndo or CancelUndo methods when calling methods from this AnnAutomation object directly. The AnnAutomation object will internally do this for you. For example, when you call the Delete method to delete the object(s) currently being edited, the AnnAutomation object will perform the above sequence internally to add the undo node.

Use the UndoCapacity property to get or set the number of user actions that can be reversed using the Undo method, or re-applied using the Redo method. The default for the UndoCapacity property is 10 actions.

For more information, refer to Undoing WPF Automation Operations.

Example

For C#/VB examples, refer to BeginUndo.

Requirements

Target Platforms