StartTransaction(String,String) Method

Used to start a new transaction that will group one or more UndoUnit actions.

Syntax

Visual Basic

'Declaration
 
Public Overloads Function StartTransaction( _
   ByVal description As String, _
   ByVal detailedDescription As String _
) As UndoTransaction

C#

public UndoTransaction StartTransaction( 
   string description,
   string detailedDescription
)

Parameters

description

The general description for the transaction.

detailedDescription

The detailed description for the transaction.

Return Value

The transaction that was created.

Remarks

A transaction is used to group one or more UndoUnit instances into a single item in the undo/redo history. The StartTranaction method is used to start a new transaction. If no transactions have been started or all tranasactions are closed, this will create a new root level transaction that is exposed via the RootTransaction. If a transaction has already been started, and therefore RootTransaction returns non-null, the new transaction will be a nested transaction of the leaf open transaction within that UndoTransaction. The method returns the newly started transaction.

Note: The Undo and Redo methods cannot be invoked while a transaction is open but one can create transactions while performing an undo/redo operation to gather the operations into a single unit.

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