Class UndoManager

A stack of undo/redo actions.

Hierarchy (View Summary)

UndoManager
- TransactionUndoManager

Index

Constructors

Accessors

Methods

addListener addUndoOperation clear getRedoDescriptions getTopRedoDescription getTopUndoDescription getUndoDescriptions hasRedo hasUndo redo setRepeatableOperation undo

Constructors

constructor

new UndoManager(maxStack?: number): UndoManager
Creates a new undo manager.
Parameters
- OptionalmaxStack: number
Returns UndoManager
Remarks
By default the stack is limited to 100 items to match Excel. This can be changed by setting the maxStack argument.

Accessors

maxStack

get maxStack(): number
Returns number

Methods

addListener

addListener(listener: IUndoManagerListener): RemoveListener
Parameters
- listener: IUndoManagerListener
Returns RemoveListener

addUndoOperation

addUndoOperation(operation: IUndoOperation): void
Add an undo operation to the stack.
Parameters
- operation: IUndoOperation
Returns void

clear

clear(notify?: boolean): void
Clear the stack.
Parameters
- Optionalnotify: boolean
Returns void

getRedoDescriptions

getRedoDescriptions(): readonly string[]
Returns readonly string[]

getTopRedoDescription

getTopRedoDescription(): string
Returns string

getTopUndoDescription

getTopUndoDescription(): string
Returns string

getUndoDescriptions

getUndoDescriptions(): readonly string[]
Returns readonly string[]

hasRedo

hasRedo(): boolean
Returns true if there are redo actions on the stack.

Returns boolean
Remarks
These can be either as a result of an undo or a repeatable action.

hasUndo

hasUndo(): boolean
Returns true if there are undo actions on the stack.

Returns boolean

redo

redo(count?: number): void
Redo the last redo actions on the stack.
Parameters
- Optionalcount: number
  number of actions to undo, default is 1.
Returns void
Remarks
The redo stack a list of all items that have an undo. Adding another item to the undo stack

setRepeatableOperation

setRepeatableOperation(operation: IRepeatableOperation): void
Sets repeatable action.
Parameters
- operation: IRepeatableOperation
Returns void
Remarks
A repeatable action is an action that a user can do multiple times 'usually on various selections'. For example styling a field adding a similar operation to the undo stack is usually expected and has to be done done separately by the caller.
- Clears the redo stack and does NOT add this operation to the undo stack.

undo

undo(count?: number): void
Undo the last actions on the stack.
Parameters
- Optionalcount: number
  number of actions to undo, default is 1.
Returns void