AddCollectionChange<TItem>(ICollection<TItem>,TItem,Int32,Int32,String) Method

Adds an UndoUnit for the specified replace collection change to the undo history.

Syntax

Visual Basic

'Declaration
 
Public Overloads Function AddCollectionChange(Of TItem)( _
   ByVal collection As ICollection(Of TItem), _
   ByVal item As TItem, _
   ByVal oldIndex As Integer, _
   ByVal newIndex As Integer, _
   Optional ByVal itemTypeDisplayName As String _
) As UndoUnit

C#

public UndoUnit AddCollectionChange<TItem>( 
   ICollection<TItem> collection,
   TItem item,
   int oldIndex,
   int newIndex,
   string itemTypeDisplayName
)

Parameters

collection

The collection that was modified

item

The item that was moved.

oldIndex

The previous index of the item.

newIndex

The new index of the item.

itemTypeDisplayName

A string representing the type of items in the collection as they should be presented to the end user or null to use the type name and/or item.

Type Parameters

TItem

The type of the item

Return Value

Returns the UndoUnit that was added or null if one was not added

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