This documentation is archived and is not being maintained.

UndoEngine.UndoUnit Class

Encapsulates a unit of work that a user can undo.


Namespace:  System.ComponentModel.Design
Assembly:  System.Design (in System.Design.dll)

protected class UndoUnit

The UndoEngine.UndoUnit type exposes the following members.

Public methodUndoEngine.UndoUnitInitializes a new instance of the UndoEngine.UndoUnit class.

Public propertyIsEmptyGets a value indicating whether the UndoEngine.UndoUnit contains no events.
Public propertyNameGets the name of the UndoEngine.UndoUnit.
Protected propertyUndoEngineGets the parent UndoEngine.

Public methodCloseReceives a call from the undo engine to close this unit.
Public methodComponentAddedReceives a call from the UndoEngine in response to a ComponentAdded event.
Public methodComponentAddingReceives a call from the UndoEngine in response to a ComponentAdding event.
Public methodComponentChangedReceives a call from the UndoEngine in response to a ComponentChanged event.
Public methodComponentChangingReceives a call from the UndoEngine in response to a ComponentChanging event.
Public methodComponentRemovedReceives a call from the UndoEngine in response to a ComponentRemoved event.
Public methodComponentRemovingReceives a call from the UndoEngine in response to a ComponentRemoving event.
Public methodComponentRenameReceives a call from the UndoEngine in response to a ComponentRename event.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Protected methodGetServiceGets an instance of the requested service.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a String that represents the current name of the unit. (Overrides Object.ToString().)
Public methodUndoPerforms an undo or redo action.
Protected methodUndoCoreCalled by Undo to perform an undo action.

The UndoEngine.UndoUnit class is a nested class within UndoEngine that encapsulates an action that a user can undo. The default UndoEngine.UndoUnit implementation monitors change notifications and builds up a list of events for each change. It saves these events using IDesignerSerializationService. An UndoEngine.UndoUnit receives event notifications for changes directly from UndoEngine through several public virtual methods. You can derive from UndoEngine.UndoUnit and perform any additional logic. If desired, you can completely bypass the default UndoEngine.UndoUnit implementation.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.