Class TextDocumentHistory

Represents a history in the text document.

Inheritance
System.Object
TextDocumentHistory
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.WinForms.SyntaxEditor.Core.History
Assembly: Telerik.WinControls.SyntaxEditor.dll

Syntax

public class TextDocumentHistory

Constructors

TextDocumentHistory(TextDocument)

Initializes a new instance of the TextDocumentHistory class.

Declaration
public TextDocumentHistory(TextDocument document)
Parameters
TextDocument document

Properties

CanRedo

Gets a value indicating whether the history can be redone.

Declaration
public bool CanRedo { get; }
Property Value
System.Boolean

CanUndo

Gets a value indicating whether the history can be undone.

Declaration
public bool CanUndo { get; }
Property Value
System.Boolean

Depth

Gets or sets the depth of the history.

Declaration
public int Depth { get; set; }
Property Value
System.Int32

IsInUndoGroup

Gets a value indicating whether this instance is in undo group.

Declaration
public bool IsInUndoGroup { get; }
Property Value
System.Boolean

Methods

Clear()

Clears the undo/redo history stacks.

Declaration
public void Clear()

OnRecordExecuted(TextChangeHistoryAction, Boolean)

Called when record is executed.

Declaration
protected virtual void OnRecordExecuted(TextChangeHistoryAction historyAction, bool isMerged)
Parameters
TextChangeHistoryAction historyAction

System.Boolean isMerged

OnRecordExecuting()

Called when record is executing.

Declaration
protected virtual void OnRecordExecuting()

OnRedoExecuted(TextChangeHistoryAction)

Called when action is redone.

Declaration
protected virtual void OnRedoExecuted(TextChangeHistoryAction historyAction)
Parameters
TextChangeHistoryAction historyAction

OnRedoExecuting(TextChangeHistoryAction)

Called when action is being redone.

Declaration
protected virtual void OnRedoExecuting(TextChangeHistoryAction historyAction)
Parameters
TextChangeHistoryAction historyAction

OnUndoExecuted(TextChangeHistoryAction)

Called when action is undone.

Declaration
protected virtual void OnUndoExecuted(TextChangeHistoryAction historyAction)
Parameters
TextChangeHistoryAction historyAction

OnUndoExecuting(TextChangeHistoryAction)

Called when action is being undone.

Declaration
protected virtual void OnUndoExecuting(TextChangeHistoryAction historyAction)
Parameters
TextChangeHistoryAction historyAction

Redo()

Performs a redo operation.

Declaration
public bool Redo()
Returns
System.Boolean

Undo()

Performs an undo operation.

Declaration
public bool Undo()
Returns
System.Boolean

Extension Methods