cancelUndo Method (AnnAutomation)
Summary
Cancels the undo node started in this AnnAutomation object.
Syntax
JavaScript Syntax
AnnAutomation.prototype.cancelUndo = function()TypeScript Syntax
cancelUndo(): void;Remarks
Use BeginUndo, EndUndo and CancelUndo to programmatically add a node to the undo stack maintained by this AnnAutomation. 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 BeginUndo, EndUndo or CancelUndo when calling methods from this AnnAutomation object. The AnnAutomation object will internally do this for you. For example, when you call the DeleteSelectedObjects 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 information on undoing or redoing automation operations, refer to Undoing Annotation Automation Operations.
Example
For an example, refer to BeginUndo.
Requirements
See Also
