Partager via

How to: Use Linked Undo Management

  • Article

Note

This article applies to Visual Studio 2015. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

Linked undo allows the user to simultaneously undo the same edits in multiple files. For example, simultaneous text changes across multiple program files, such as a header file and a Visual C++ file, is a linked undo transaction. Linked undo capability is built into the environment's implementation of the undo manager, and IVsLinkedUndoTransactionManager lets you manipulate this capability. Linked undo is implemented by a parent undo unit that can link separate undo stacks together to be treated as a single undo unit. The procedure for using linked undo is detailed in the following section.

To use linked undo

  1. Call QueryService on SVsLinkedUndoManager to get a pointer to IVsLinkedUndoTransactionManager.

  2. Create the initial parent linked undo unit by calling OpenLinkedUndo. This sets the starting point for a set of undo stacks to be grouped into linked undo stacks. In the OpenLinkedUndo method you will also need to specify whether you want the linked undo to be strict or non-strict. Non-strict linked undo behavior means that some of the documents with linked undo siblings can close and still leave the other linked undo siblings on their stacks. Strict linked undo behavior specifies that all the linked undo sibling stacks have to be undone together or not at all. Add the subsequent linked undo stacks by calling IOleUndoManager::Add method.

  3. Call CloseLinkedUndo to roll back all of the linked undo units as one.

    Note

    To implement linked undo management in an editor, add undo management. For more information on implementing linked undo management, see How to: Implement Undo Management.

See Also

IVsCompoundAction
IOleParentUndoUnit
IOleUndoUnit
How to: Implement Undo Management