UndoEngine.CreateUndoUnit(String, Boolean) Method

Definition

Creates a new UndoEngine.UndoUnit.

protected:
 virtual System::ComponentModel::Design::UndoEngine::UndoUnit ^ CreateUndoUnit(System::String ^ name, bool primary);
protected virtual System.ComponentModel.Design.UndoEngine.UndoUnit CreateUndoUnit (string name, bool primary);
abstract member CreateUndoUnit : string * bool -> System.ComponentModel.Design.UndoEngine.UndoUnit
override this.CreateUndoUnit : string * bool -> System.ComponentModel.Design.UndoEngine.UndoUnit
Protected Overridable Function CreateUndoUnit (name As String, primary As Boolean) As UndoEngine.UndoUnit

Parameters

name
String

The name of the unit to create.

primary
Boolean

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

Returns

A new UndoEngine.UndoUnit with a specified name.

Remarks

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.

Applies to