Version

Methods Reference for Adding UndoUnits to the Undo History

Topic Overview

Purpose

This topic lists the available methods for adding an UndoUnit derived class object to the undo history.

Required background

The following table lists the topics required as a prerequisite to understanding this topic.

Topic Purpose

This topic lists some of the important properties and methods of the UndoManager class.

This topic lists the derived classes and some of the important properties and methods of the UndoUnit class.

Methods Reference for Adding UndoUnits to the Undo History

Introduction

The UndoManager class provides a number of helper methods that construct an UndoUnit and add the unit to the undo history.

Methods reference summary

The following table summarizes the purpose and functionality of the UndoManager methods for adding UndoUnits to the undo history.

Method Description

This is an UndoManager method that may be used to add any UndoUnit derived class object to the undo history.

The method has numerous overloads.

For all overloads except the AddChange(UndoUnit), the UndoUnit representing the change will automatically add itself back into the history (calling AddChange passing in itself). Therefore these delegates should not result in the same AddChange method being invoked.

These methods ultimately delegate the creation of the UndoUnit instance to the UndoUnitFactory of the UndoManager whose history will be updated. It is possible to change the UndoUnit instance that is used for these operations without needing to change the call to these methods.

This method adds an UndoUnit for collection change in the history.

There are several overloads that take a collection of type ICollection<T> and information about the type of change that occurred in the collection as parameters.

This method adds an PropertyChangeUndoUnitBase for the specified property value change to the undo history.

The method has numerous overloads that take as parameters:

  • the reference to the object whose property was changed

  • the old value of the property

  • the new value of the property

  • additional information that identifies the property that was changed

Related Content

Topics

The following topics provide additional information related to this topic.

Topic Purpose

This topic lists the available methods for removing the UndoUnit instances from the undo/redo history.

This topic lists the methods that register/unregister a specific object to an UndoManager instance.

This topic lists the available methods for performing undo and redo operations.

This topic lists the available methods and properties for performing undo/redo transactions.

This topic lists the available methods and properties related to the merging of undo/redo operations.

This topic lists the available commands in the Infragistics Undo/Redo Framework™.

This topic lists the available methods for suspending and resuming the saving of the undo/redo operations in history.

This topic lists the available methods and properties related to creating of a custom UndoUnit in the Infragistics Undo/Redo Framework™.