UndoManager Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Summary description for UndoManager.
public ref class UndoManager : IDisposable
public class UndoManager : IDisposable
type UndoManager = class
interface IDisposable
Public Class UndoManager
Implements IDisposable
- Inheritance
-
UndoManager
- Implements
Constructors
UndoManager(Context) |
constructor. |
UndoManager(Store) |
constructor. |
Properties
CanUndoRedoCallbackCollection |
CanUndoRedo voters. |
Context |
The Context that contains the UndoManager |
InRedo |
Return whether are not the undo manager is in the middle of a redo or not. |
InUndo |
Return whether are not the undo manager is in the middle of an undo or not. |
MaxUndoableTransactions |
Maximum number of undo items visible on the undo stack |
RedoableTransactions |
List of redoable TransactionItems maintained by the UndoManager. |
RedoCount |
Number of items in redo stack |
Store |
The Store that contains the UndoManager |
TopmostUndoableTransaction |
Return topmost transaction ID in undo stact |
UndoableTransactions |
List of undoable TransactionItems maintained by the UndoManager. |
UndoCount |
Number of items in undo stack. |
UndoState |
The state of Undo. |
Methods
AddCanUndoRedoCallback(CanUndoRedoCallback) |
Add CanUndoRedo voter. |
AddUndoableAction(Transaction) |
Add an undoable action to the undo stack. This will clear the redo stack. |
Dispose() |
Dispose method |
Finalize() |
Finalizer |
Flush() |
Flush the undo and redo stacks. If we are in the middle of a transaction, throw an exception. |
FlushRedoStack() |
Clears the redo stack. |
Redo() |
Redo the actions of the topmost transaction on the redo stack. |
Redo(Guid) |
Redo the actions committed in the transaction whose id is passed in. Make sure the id passed in is the transaction that is on top of the stack. Otherwise throw an exception. |
RedoAllPossible() |
Redo all possible transactions on redo stack. |
RemoveCanUndoRedoCallback(CanUndoRedoCallback) |
Remove CanUndoRedo voter. |
Undo() |
Undo the actions of the topmost transaction on undo stack. |
Undo(Guid) |
Undo the actions committed in the transaction whose id is passed in. Make sure the id passed in is the transaction that is on top of the stack. Otherwise throw an exception. |
UndoAllPossible() |
Undo all transactions in undo stack that can be undone. |
Events
RedoStackFlushed |
Allows clients to receive an event when the redo stack is flushed |
UndoItemAdded |
Event that is fired every time an undo item is added to the undo stack |
UndoItemDiscarded |
Event that is fired every time an undo item is discarded from the undo stack because the stack size exceeded the maximum number of undo items permitted. |
UndoStackFlushed |
Allows clients to receive an event when the undo stack is flushed |