BeginUndoTransaction Method

Begins a transaction for the undo stack that optionally takes a snapshot.

Syntax

Visual Basic

'Declaration
 
Public Sub BeginUndoTransaction( _
   ByVal takeUndoSnapshot As Boolean _
) 

C#

public void BeginUndoTransaction( 
   bool takeUndoSnapshot
)

Parameters

takeUndoSnapshot

True to take an undo snapshot and allow the operation to be undone; otherwise false.

Remarks

Beginning a transaction will combine any future undo-able operations into the current action and thus treat all actions performed as one atomic operation for the purposes of Undo and Redo functionality.

Specifying false for takeUndoSnapshot means that the operations will not actually be recorded. This is useful in cases where operations are performed in code that users should not be able to undo, or in cases where performance is an issue.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, 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