GetDescription Method (CustomUndoUnit)

Returns a string representation of the action based on whether this is for an undo or redo operation.

Syntax

Visual Basic

'Declaration
 
Public Overrides Function GetDescription( _
   ByVal itemType As UndoHistoryItemType, _
   ByVal detailed As Boolean _
) As String

C#

public override string GetDescription( 
   UndoHistoryItemType itemType,
   bool detailed
)

Parameters

itemType

The type of history for which the description is being requested.

detailed

A boolean indicating if a detailed description should be returned. For example, when false one may return "Typing" but for verbose one may return "Typing 'qwerty'".

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