ClearUndoRedoHistory Method

Removes all the Undo and Redo history that relates to this RichTextDocument.

Syntax

Visual Basic

'Declaration
 
Public Sub ClearUndoRedoHistory( _
   Optional ByVal includeRootTransaction As Boolean _
) 

C#

public void ClearUndoRedoHistory( 
   bool includeRootTransaction
)

Parameters

includeRootTransaction

Indicates whether this method should affect the current open RootTransaction on the UndoManager if there is one.

Remarks

Note: this is equivalent to calling the UndoManager's RemoveAll method with a filter that removes only undo units whose Target is this RichTextDocument. By default that will be all of the history, however, since the UndoManager property is settable it is possible to share a single instance of an UndoManager with more that one RichTextDocument so that there histories are mingled.

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