UndoEngine.CreateUndoUnit Method (String, Boolean)

 

Creates a new UndoEngine.UndoUnit.

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

protected virtual UndoEngine.UndoUnit CreateUndoUnit(
	string name,
	bool primary
)

Parameters

name
Type: System.String

The name of the unit to create.

primary
Type: System.Boolean

true to create the first of a series of nested units; false to create subsequent nested units.

Return Value

Type: System.ComponentModel.Design.UndoEngine.UndoUnit

A new UndoEngine.UndoUnit with a specified name.

The default implementation of the CreateUndoUnit method simply returns a new UndoEngine.UndoUnit.

By default, UndoEngine does nothing with the primary parameter, but some implementations of undo, such as those involving the COM Microsoft.VisualStudio.OLE.Interop.IOleParentUndoUnit design pattern, may need to identify the difference between a primary unit and its children.

.NET Framework
Available since 2.0
Return to top
Show: