Class

WorkbookHistory

The default depth of the workbook history.

Declaration

public const int DefaultDepth = 2147483647

Field Value

Indicates whether the redo stack contains actions available to reapply.

Declaration

public bool CanRedo { get; }

Property Value

Indicates whether the undo stack contains actions available to reverse.

Declaration

public bool CanUndo { get; }

Property Value

Maximum number of actions retained in the undo stack before oldest entries are discarded.

Declaration

public int Depth { get; set; }

Property Value

Controls whether commands are recorded in the undo/redo stacks; when disabled, history is cleared and recording stops.

Declaration

public bool IsEnabled { get; set; }

Property Value

Indicates whether multiple commands are being batched into a single undoable action via BeginUndoGroup/EndUndoGroup.

Declaration

public bool IsInUndoGroup { get; }

Property Value

Workbook instance whose modification history is tracked by this history manager.

Declaration

public Workbook Workbook { get; }

Property Value

Starts batching subsequent commands into a single composite action that will undo/redo together.

Declaration

public void BeginUndoGroup()

Aborts the current undo group and reverts all commands executed within it.

Declaration

public void CancelUndoGroup()

Removes all actions from both undo and redo stacks, resetting history to empty.

Declaration

public void Clear()

Completes the current undo group and commits the batched commands as a single history entry.

Declaration

public void EndUndoGroup()

Invokes the Cleared event after removing all history entries.

Declaration

protected virtual void OnCleared()

Invokes the RecordExecuted event after committing a history action.

Declaration

protected virtual void OnRecordExecuted(WorkbookHistoryAction historyAction, bool isMerged)

Parameters

Invokes the RecordExecuting event when history recording starts.

Declaration

protected virtual void OnRecordExecuting()

Invokes the RedoExecuted event after completing a redo operation.

Declaration

protected virtual void OnRedoExecuted(WorkbookHistoryAction historyAction)

Parameters

Invokes the RedoExecuting event before reapplying a history action.

Declaration

protected virtual void OnRedoExecuting(WorkbookHistoryAction historyAction)

Parameters

Invokes the UndoExecuted event after completing an undo operation.

Declaration

protected virtual void OnUndoExecuted(WorkbookHistoryAction historyAction)

Parameters

Invokes the UndoExecuting event before reversing a history action.

Declaration

protected virtual void OnUndoExecuting(WorkbookHistoryAction historyAction)

Parameters

Reapplies the most recently undone action from the redo stack and returns whether the operation succeeded.

Declaration

public bool Redo()

Returns

Reverses the most recent action from the undo stack and returns whether the operation succeeded.

Declaration

public bool Undo()

Returns

Raised when all history entries are removed from the undo and redo stacks.

Declaration

public event EventHandler Cleared

Event Value

Raised after a history record is committed to the undo stack, providing the recorded action details.

Declaration

public event EventHandler<WorkbookHistoryRecordExecutedEventArgs> RecordExecuted

Event Value

Raised before a new history record begins recording, signaling the start of an undo group.

Declaration

public event EventHandler RecordExecuting

Event Value

Raised after a redo operation completes, providing the action that was reapplied.

Declaration

public event EventHandler<WorkbookHistoryEventArgs> RedoExecuted

Event Value

Raised before a redo operation begins, providing the action about to be reapplied.

Declaration

public event EventHandler<WorkbookHistoryEventArgs> RedoExecuting

Event Value

Raised after an undo operation completes, providing the action that was reversed.

Declaration

public event EventHandler<WorkbookHistoryEventArgs> UndoExecuted

Event Value

Raised before an undo operation begins, providing the action about to be reversed.

Declaration

public event EventHandler<WorkbookHistoryEventArgs> UndoExecuting

Event Value