CreateChange Method

Creates an UndoUnit for the specified method.

Syntax

Visual Basic

'Declaration
 
Public Overridable Function CreateChange( _
   ByVal description As String, _
   ByVal detailedDescription As String, _
   ByVal undoMethod As Func(Of UndoExecuteContext,Boolean), _
   ByVal redoMethod As Func(Of UndoExecuteContext,Boolean), _
   ByVal target As Object _
) As UndoUnit

C#

public virtual UndoUnit CreateChange( 
   string description,
   string detailedDescription,
   Func<UndoExecuteContext,bool> undoMethod,
   Func<UndoExecuteContext,bool> redoMethod,
   object target
)

Parameters

description

The description for the transaction.

detailedDescription

The more detailed description for the operation.

undoMethod

The method to be invoked when an Undo is being performed. The method returns a boolean indicating if the operation was successful.

redoMethod

The method to be invoked when an Redo is being performed. The method returns a boolean indicating if the operation was successful.

target

The object that is the target of the function. This information is exposed via the UndoUnit.Target property.

Return Value

An UndoUnit that can be used to undo the operation

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2