UndoTransactionState Enum

Definition

Namespace:

Microsoft.VisualStudio.Text.Operations

Assembly:

Microsoft.VisualStudio.Text.Logic.dll

Package:

Microsoft.VisualStudio.Text.Logic v17.12.215

Holds the state of the transaction.

public enum class UndoTransactionState

public enum class UndoTransactionState

enum UndoTransactionState

public enum UndoTransactionState

type UndoTransactionState = 

Public Enum UndoTransactionState

Inheritance

Enum

UndoTransactionState

Fields

Name	Value	Description
Open	0	Represents the initial state of the transaction, after it has been created and before it is canceled or completed.
Completed	1	Indicates that the transaction is no longer being defined, and is eligible for undo.
Canceled	2	Indicates that the transaction is no longer being defined, but has been aborted and cleared.
Redoing	3	Indicates a transient state set by Do(), between the undone state and the completed state.
Undoing	4	Indicates a transient state set by Undo(), between the completed state and the Undone state.
Undone	5	Indicates that Undo() was called after completion.
Invalid	6	Indicates that the transaction has been removed the undo history stack, for example because it was on the redo stack when a new operation cleared the redo stack. Once a transaction is invalid it should not be used for anything.

Remarks

There are five rough groups of transactions. Open transactions are being defined. Canceled transactions have been aborted and are empty. Completed and undone transactions have been defined and are ready for undo and redo, respectively. Undoing and redoing are transient states as the transaction passes between completed and undone. Invalid is a state for transactions that have expired.