ITextUndoHistory Interface

Definition

Namespace:

Microsoft.VisualStudio.Text.Operations

Assembly:

Microsoft.VisualStudio.Text.Logic.dll

Package:

Microsoft.VisualStudio.Text.Logic v17.12.215

Contains undo transactions.

public interface class ITextUndoHistory : Microsoft::VisualStudio::Utilities::IPropertyOwner

public interface class ITextUndoHistory : Microsoft::VisualStudio::Utilities::IPropertyOwner

__interface ITextUndoHistory : Microsoft::VisualStudio::Utilities::IPropertyOwner

public interface ITextUndoHistory : Microsoft.VisualStudio.Utilities.IPropertyOwner

type ITextUndoHistory = interface
    interface IPropertyOwner

Public Interface ITextUndoHistory
Implements IPropertyOwner

Implements

IPropertyOwner

Remarks

Typically only one undo transaction history at a time is available to the user.

Properties

CanRedo	Determines whether a single redo is possible.
CanUndo	Determines whether a single undo is possible.
CurrentTransaction	Gets the current UndoTransaction in progress.
LastRedoTransaction	Gets the most recent (top) item of the RedoStack, or null if the stack is empty.
LastUndoTransaction	Gets the most recent (top) item of the UndoStack, or null if the stack is empty.
Properties	The collection of properties controlled by the property owner. (Inherited from IPropertyOwner)
RedoDescription	Gets the description of the most recent visible redo ITextUndoTransaction.
RedoStack	The redo stack for this history. It does not include any currently open or undo transactions.
State	Gets the current state of the UndoHistory.
UndoDescription	Gets the description of the most recent visible undo ITextUndoTransaction.
UndoStack	The undo stack for this history. It does not include any currently open or redo transactions.

Methods

CreateTransaction(String)	Creates a new transaction, nests it in the previously current transaction, and marks it current.
Redo(Int32)	Performs the specified number of redo operation and places the transactions on the undo stack.
Undo(Int32)	Performs the specified number of undo operations and places the transactions on the redo stack.

Events

UndoRedoHappened	Notifies consumers when an undo or a redo has happened on this history.
UndoTransactionCompleted	Notifies consumers when an ITextUndoTransaction is completed and added to the UndoStack.