OleUndoEngine.CreateUndoUnit Method

This member overrides UndoEngine.CreateUndoUnit(String, Boolean), and more complete documentation might be available in that topic.

Creates a new undo unit.

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

Syntax

'Declaration
Protected Overrides Function CreateUndoUnit ( _
    name As String, _
    primary As Boolean _
) As UndoEngine.UndoUnit
'Usage
Dim name As String 
Dim primary As Boolean 
Dim returnValue As UndoEngine.UndoUnit 

returnValue = Me.CreateUndoUnit(name, _
    primary)
protected override UndoEngine.UndoUnit CreateUndoUnit(
    string name,
    bool primary
)
protected:
virtual UndoEngine.UndoUnit^ CreateUndoUnit(
    String^ name, 
    bool primary
) override
protected override function CreateUndoUnit(
    name : String, 
    primary : boolean
) : UndoEngine.UndoUnit

Parameters

  • primary
    Type: System.Boolean

    true if the undo unit is primary, otherwise false.

Return Value

Type: System.ComponentModel.Design.UndoEngine.UndoUnit
The created UndoEngine.UndoUnit.

Remarks

This method also sets the returned undo unit as the latest "clean" one if the DocData object has not been modified in it. If this undo unit gets undone, these flags will be reset.

.NET Framework Security

See Also

Reference

OleUndoEngine Class

OleUndoEngine Members

Microsoft.VisualStudio.Shell.Design Namespace

UndoEngine.UndoUnit

OleUndoEngine

OnInterveningUnitBlockingLinkedUndo

IVsLinkedUndoClient

OleUndoEngine

AddUndoUnit

DiscardUndoUnit

Dispose

Other Resources

Supplying Undo Support to Designers