Class WorkbookHistory

Represents the history of a workbook.

Inheritance

System.Object

WorkbookHistory

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Telerik.Windows.Documents.Spreadsheet.History

Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class WorkbookHistory

Fields

DefaultDepth

The default depth of the workbook history.

Declaration

public const int DefaultDepth = 2147483647

Field Value

System.Int32

Properties

CanRedo

Gets a value indicating whether redo can be performed.

Declaration

public bool CanRedo { get; }

Property Value

System.Boolean The value indicating whether redo can be performed.

CanUndo

Gets a value indicating whether undo can be performed.

Declaration

public bool CanUndo { get; }

Property Value

System.Boolean The value indicating whether undo can be performed.

Depth

Gets or sets the depth of the history.

Declaration

public int Depth { get; set; }

Property Value

System.Int32 The depth of the history.

IsEnabled

Gets or sets a value indicating whether history is enabled.

Declaration

public bool IsEnabled { get; set; }

Property Value

System.Boolean The value indicating whether history is enabled.

IsInUndoGroup

Gets a value indicating whether the history is currently recording an undo group.

Declaration

public bool IsInUndoGroup { get; }

Property Value

System.Boolean The value indicating whether the history is currently recording an undo group.

Workbook

Gets the workbook.

Declaration

public Workbook Workbook { get; }

Property Value

Workbook The workbook.

Methods

BeginUndoGroup()

Begins the undo group.

Declaration

public void BeginUndoGroup()

CancelUndoGroup()

Cancels the undo group.

Declaration

public void CancelUndoGroup()

Clear()

Clears the workbook history.

Declaration

public void Clear()

EndUndoGroup()

Ends the undo group.

Declaration

public void EndUndoGroup()

OnCleared()

Called when history has been cleared.

Declaration

protected virtual void OnCleared()

OnRecordExecuted(WorkbookHistoryAction, Boolean)

Called when a record is executed.

Declaration

protected virtual void OnRecordExecuted(WorkbookHistoryAction historyAction, bool isMerged)

Parameters

WorkbookHistoryAction historyAction The history action.

System.Boolean isMerged This parameter is not used and is reserved for future use.

OnRecordExecuting()

Called when a record is executing.

Declaration

protected virtual void OnRecordExecuting()

OnRedoExecuted(WorkbookHistoryAction)

Called when redo has been executed.

Declaration

protected virtual void OnRedoExecuted(WorkbookHistoryAction historyAction)

Parameters

WorkbookHistoryAction historyAction The history action.

OnRedoExecuting(WorkbookHistoryAction)

Called when redo is being executed.

Declaration

protected virtual void OnRedoExecuting(WorkbookHistoryAction historyAction)

Parameters

WorkbookHistoryAction historyAction The history action.

OnUndoExecuted(WorkbookHistoryAction)

Called when undo has been executed.

Declaration

protected virtual void OnUndoExecuted(WorkbookHistoryAction historyAction)

Parameters

WorkbookHistoryAction historyAction The history action.

OnUndoExecuting(WorkbookHistoryAction)

Called when undo is being executed.

Declaration

protected virtual void OnUndoExecuting(WorkbookHistoryAction historyAction)

Parameters

WorkbookHistoryAction historyAction The history action.

Redo()

Performs the redo action.

Declaration

public bool Redo()

Returns

System.Boolean The value indicating whether the redo was successfully performed.

Undo()

Performs the undo action.

Declaration

public bool Undo()

Returns

System.Boolean The value indicating whether the undo was successfully performed.

Events

Cleared

Occurs when history has been cleared.

Declaration

public event EventHandler Cleared

Event Type

System.EventHandler

RecordExecuted

Occurs when a record has executed.

Declaration

public event EventHandler<WorkbookHistoryRecordExecutedEventArgs> RecordExecuted

Event Type

System.EventHandler<WorkbookHistoryRecordExecutedEventArgs>

RecordExecuting

Occurs when a record is executing.

Declaration

public event EventHandler RecordExecuting

Event Type

System.EventHandler

RedoExecuted

Occurs when redo has been executed.

Declaration

public event EventHandler<WorkbookHistoryEventArgs> RedoExecuted

Event Type

System.EventHandler<WorkbookHistoryEventArgs>

RedoExecuting

Occurs when redo is being executed.

Declaration

public event EventHandler<WorkbookHistoryEventArgs> RedoExecuting

Event Type

System.EventHandler<WorkbookHistoryEventArgs>

UndoExecuted

Occurs when undo has been executed.

Declaration

public event EventHandler<WorkbookHistoryEventArgs> UndoExecuted

Event Type

System.EventHandler<WorkbookHistoryEventArgs>

UndoExecuting

Occurs when undo is being executed.

Declaration

public event EventHandler<WorkbookHistoryEventArgs> UndoExecuting

Event Type

System.EventHandler<WorkbookHistoryEventArgs>