This documentation is archived and is not being maintained.

ListView.ListViewItemCollection.Insert Method (Int32, String, Int32)

Creates a new item with the specified image index and inserts it into the collection at the specified index.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public ListViewItem Insert(
	int index,
	string text,
	int imageIndex
)

Parameters

index
Type: System.Int32
The zero-based index location where the item is inserted.
text
Type: System.String
The text to display for the item.
imageIndex
Type: System.Int32
The index of the image to display for the item.

Return Value

Type: System.Windows.Forms.ListViewItem
The ListViewItem that was inserted into the collection.

ExceptionCondition
ArgumentOutOfRangeException

The index parameter is less than 0 or greater than the value of the Count property of the ListView.ListViewItemCollection.

This version of the Insert method allows you to insert a new item at a specific position in the ListView.ListViewItemCollection. The text specified in the text parameter is used to create a new ListViewItem that is then inserted into the ListView.ListViewItemCollection at the specified location.

NoteNote

If the ListView.Sorting property is set to a value other than SortOrder.None or if the ListViewItemSorter property is set, the list is sorted after the item is inserted.

You can also use this version of the Insert method to specify an image for the item by passing the index of the ImageList assigned to the ListView.LargeImageList and ListView.SmallImageList properties to the imageIndex parameter. (Typically, the ListView.LargeImageList and ListView.SmallImageList properties use the same index positions to display related images.) If you do not want to specify an image index for the item, use the other version of the Insert method that accepts a string as a parameter.

To add an item without specifying a specific position in the collection, use the Add method. If you want to add an array of items to the collection, use the AddRange method.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: