AnnotationUndoManager Class

The AnnotationUndoManager keeps track of annotation changes and allows undo and redo functionality.

Inheritance Hierarchy

SystemObject
Atalasoft.Annotate.UIAnnotationUndoManager

Namespace: Atalasoft.Annotate.UI
Assembly: Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

Copy

public class AnnotationUndoManager

Public Class AnnotationUndoManager

The AnnotationUndoManager type exposes the following members.

Constructors

	Name	Description
	AnnotationUndoManager	Creates a new instance of AnnotationUndoManager.

Top

Properties

	Name	Description
	Levels	Gets or sets the number of undo/redo levels to keep in memory.
	Merging	Gets a value indicating whether the manager is merging undos added into a single undo action.
	RedoCount	Gets the number of redos available.
	RedoDescription	Gets the description string of the redo that will be performed when Redo is called.
	UndoCount	Gets the number of undos available.
	UndoDescription	Gets the description string of the undo that will be performed when Undo is called.

Top

Methods

	Name	Description
	AddUndo	Adds an undo to the collection.
	BeginUndoMerge	This method puts the AnnotationUndoManager into a collective undo state. All calls to AddUndo(AnnotationUndo) will be collected until the EndUndoMerge(String) method has been called.
	Clear	Clears the undo and redo collections.
	EndUndoMerge	Exits the collective undo state and stores all actions added since the BeginUndoMerge call as a single undo operation.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetRedoDescriptions	Returns a string array of the descriptions in the order which they would be redone. This is useful for displaying a list of items to redo. For displaying only the latest redo description use the RedoDescription method.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUndoDescriptions	Returns a string array of the descriptions in the order which they would be undone. This is useful for displaying a list of items to undo. For displaying only the latest undo description use the UndoDescription method.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Redo	Performs a redo on the collection and raises the RedoRequest event with the AnnotationUndo that was processed.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Undo	Performs an undo on the collection and raises the UndoRequest event with the AnnotationUndo that was processed.

Top

Events

	Name	Description
	RedoRequest	Raised when a call to Redo has been requested.
	UndoListChanged	Raised when the items in the undo stack have changed.
	UndoRequest	Raised when a call to Undo has been requested.

Top

Remarks

In addition to annotation property changes, the undo manager will track adding and removing annotations from a layer. This includes adding and removing LayerAnnotation objects in the LayerCollection.

Reference

Atalasoft.Annotate.UI Namespace