OleUndoEngine.UndoUnit Class

 

Extends support for encapsulating a unit of work that a user can undo.

Namespace:   Microsoft.VisualStudio.Shell.Design
Assembly:  Microsoft.VisualStudio.Shell.Design (in Microsoft.VisualStudio.Shell.Design.dll)

System.Object
  System.ComponentModel.Design.UndoEngine.UndoUnit
    Microsoft.VisualStudio.Shell.Design.OleUndoEngine.UndoUnit

protected class UndoUnit : UndoEngine.UndoUnit, IOleUndoUnit, 
	IOleParentUndoUnit

NameDescription
System_CAPS_pubmethodOleUndoEngine.UndoUnit(UndoEngine, String)

Initializes a new instance of the OleUndoEngine.UndoUnit class.

NameDescription
System_CAPS_pubpropertyIsEmpty

(Inherited from UndoEngine.UndoUnit.)

System_CAPS_pubpropertyName

(Inherited from UndoEngine.UndoUnit.)

System_CAPS_protpropertyUndoEngine

(Inherited from UndoEngine.UndoUnit.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleParentUndoUnit.Add(IOleUndoUnit)

Adds an undo unit to the parent collection.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleParentUndoUnit.Close(IOleParentUndoUnit, Int32)

Closes the specified parent undo unit.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleParentUndoUnit.Do(IOleUndoManager)

Performs the undo operation.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleParentUndoUnit.FindUnit(IOleUndoUnit)

Searches for the specified unit in the child undo unit hierarchy.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleParentUndoUnit.GetDescription(String)

Gets the description of the undo unit.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleParentUndoUnit.GetParentState(UInt32)

Gets the state of the top-level parent undo unit.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleParentUndoUnit.GetUnitType(Guid, Int32)

Gets the type of the undo unit.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleParentUndoUnit.OnNextAdd()

Notifies the last undo unit in the collection that a new unit has been added.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleParentUndoUnit.Open(IOleParentUndoUnit)

Opens an undo unit.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleUndoUnit.Do(IOleUndoManager)

Performs the undo operation.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleUndoUnit.GetDescription(String)

Gets the description of the undo unit.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleUndoUnit.GetUnitType(Guid, Int32)

Gets the type of the undo unit.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleUndoUnit.OnNextAdd()

Notifies the last undo unit in the collection that a new unit has been added.

The OleUndoEngine.UndoUnit class is a nested class within OleUndoEngine that encapsulates an action that a user can undo by monitoring change notifications and builds up a list of events for each change.

It saves these events using IDesignerSerializationService. An OleUndoEngine.UndoUnit receives event notifications for changes through several methods derived from UndoEngine.UndoUnit, IOleParentUndoUnit and

IOleUndoUnit

By implementing UndoEngine.UndoUnit, IOleParentUndoUnit, and IOleUndoUnit, OleUndoEngine.UndoUnit is able to better support linked undo by providing explicit connection between parent and child undo units.

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

Return to top
Show: