ListView.ListViewItemCollection Class
TOC
Collapse the table of content
Expand the table of content

ListView.ListViewItemCollection Class

 

Represents the collection of items in a ListView control or assigned to a ListViewGroup.

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

System.Object
  System.Windows.Forms.ListView.ListViewItemCollection

[ListBindableAttribute(false)]
public class ListViewItemCollection : IList, ICollection, IEnumerable

NameDescription
System_CAPS_pubmethodListView.ListViewItemCollection(ListView)

Initializes a new instance of the ListView.ListViewItemCollection class.

NameDescription
System_CAPS_pubpropertyCount

Gets the number of items in the collection.

System_CAPS_pubpropertyIsReadOnly

Gets a value indicating whether the collection is read-only.

System_CAPS_pubpropertyItem[Int32]

Gets or sets the item at the specified index within the collection.

System_CAPS_pubpropertyItem[String]

Retrieves the item with the specified key.

NameDescription
System_CAPS_pubmethodAdd(ListViewItem)

Adds an existing ListViewItem to the collection.

System_CAPS_pubmethodAdd(String)

Creates an item with the specified text and adds it to the collection.

System_CAPS_pubmethodAdd(String, Int32)

Creates an item with the specified text and image and adds it to the collection.

System_CAPS_pubmethodAdd(String, String)

Creates an item with the specified text and image and adds it to the collection.

System_CAPS_pubmethodAdd(String, String, Int32)

Creates an item with the specified key, text, and image and adds an item to the collection.

System_CAPS_pubmethodAdd(String, String, String)

Creates an item with the specified key, text, and image, and adds it to the collection.

System_CAPS_pubmethodAddRange(ListViewItem[])

Adds an array of ListViewItem objects to the collection.

System_CAPS_pubmethodAddRange(ListView.ListViewItemCollection)

Adds a collection of items to the collection.

System_CAPS_pubmethodClear()

Removes all items from the collection.

System_CAPS_pubmethodContains(ListViewItem)

Determines whether the specified item is located in the collection.

System_CAPS_pubmethodContainsKey(String)

Determines whether the collection contains an item with the specified key.

System_CAPS_pubmethodCopyTo(Array, Int32)

Copies the entire collection into an existing array at a specified location within the array.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFind(String, Boolean)

Searches for items whose name matches the specified key, optionally searching subitems.

System_CAPS_pubmethodGetEnumerator()

Returns an enumerator to use to iterate through the item collection.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIndexOf(ListViewItem)

Returns the index within the collection of the specified item.

System_CAPS_pubmethodIndexOfKey(String)

Retrieves the index of the item with the specified key.

System_CAPS_pubmethodInsert(Int32, ListViewItem)

Inserts an existing ListViewItem into the collection at the specified index.

System_CAPS_pubmethodInsert(Int32, String)

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

System_CAPS_pubmethodInsert(Int32, String, Int32)

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

System_CAPS_pubmethodInsert(Int32, String, String)

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

System_CAPS_pubmethodInsert(Int32, String, String, Int32)

Creates a new item with the specified key, text, and image, and inserts it in the collection at the specified index.

System_CAPS_pubmethodInsert(Int32, String, String, String)

Creates a new item with the specified key, text, and image, and adds it to the collection at the specified index.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodRemove(ListViewItem)

Removes the specified item from the collection.

System_CAPS_pubmethodRemoveAt(Int32)

Removes the item at the specified index within the collection.

System_CAPS_pubmethodRemoveByKey(String)

Removes the item with the specified key from the collection.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Add(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Adds an existing object to the collection.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Contains(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Determines whether the specified item is in the collection.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.IndexOf(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the index within the collection of the specified item.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Insert(Int32, Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Inserts an object into the collection at the specified index.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Remove(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Removes the specified item from the collection.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.IsSynchronized

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value indicating whether access to the collection is synchronized (thread safe).

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.SyncRoot

This API supports the product infrastructure and is not intended to be used directly from your code. Gets an object that can be used to synchronize access to the collection of controls.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.IsFixedSize

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value indicating whether the collection has a fixed size.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.Item[Int32]

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the ListViewItem at the specified index within the collection.

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

A ListView.ListViewItemCollection stores the items displayed in a ListView control or assigned to a ListViewGroup. There are two other collections defined within the ListView class that enable you to determine what items are selected within a ListView control. The ListView.SelectedListViewItemCollection class provides properties and methods for determining what items are selected in a ListView control, while the ListView.SelectedIndexCollection class enables you to determine what indexes within the ListView.ListViewItemCollection of a ListView control are selected. In addition to selection collection classes, there are also two classes that enable you to determine what items are checked (when the CheckBoxes property of the ListView control is set to true) within this collection.

There are a number of ways to add items to the collection. The Add method adds a single item to the collection. To add a number of items to the collection, you create an array of items and pass it to the AddRange method. If you want to insert an item at a specific location in the collection, you can use the Insert method. To remove items, you can use either the Remove method or the RemoveAt method if you know where the item is located in the collection. The Clear method enables you to remove all items from the collection instead of using the Remove method to remove a single item at a time.

In addition to methods and properties for adding and removing items, the ListView.ListViewItemCollection also provides methods to find items in the collection. The Contains method enables you to determine whether an item is a member of the collection. Once you know that the item is located in the collection, you can use the IndexOf method to determine where the item is located in the collection.

The following code example demonstrates how to add items to a ListView.ListViewItemCollection. Note that the Items property of ListView1 is of type ListView.ListViewItemCollection. To run this example, paste the following code into a form that contains a ListView object named ListView1 and a TextBox named TextBox1. Call the InitializeListView method from the form's constructor or Load event handler.

// This method adds two columns to the ListView, setting the Text 
// and TextAlign, and Width properties of each ColumnHeader.  The 
// HeaderStyle property is set to NonClickable since the ColumnClick 
// event is not handled.  Finally the method adds ListViewItems and 
// SubItems to each column.
private void InitializeListView()
{
	this.ListView1 = new System.Windows.Forms.ListView();
	this.ListView1.BackColor = System.Drawing.SystemColors.Control;
	this.ListView1.Dock = System.Windows.Forms.DockStyle.Top;
	this.ListView1.Location = new System.Drawing.Point(0, 0);
	this.ListView1.Name = "ListView1";
	this.ListView1.Size = new System.Drawing.Size(292, 130);
	this.ListView1.TabIndex = 0;
	this.ListView1.View = System.Windows.Forms.View.Details;
	this.ListView1.MultiSelect = true;
	this.ListView1.HideSelection = false;
	this.ListView1.HeaderStyle = ColumnHeaderStyle.Nonclickable;

	ColumnHeader columnHeader1 = new ColumnHeader();
	columnHeader1.Text = "Breakfast Item";
	columnHeader1.TextAlign = HorizontalAlignment.Left;
	columnHeader1.Width = 146;

 	ColumnHeader columnHeader2 = new ColumnHeader();
	columnHeader2.Text = "Price Each";
	columnHeader2.TextAlign = HorizontalAlignment.Center;
	columnHeader2.Width = 142;

	this.ListView1.Columns.Add(columnHeader1);
	this.ListView1.Columns.Add(columnHeader2);

	string[] foodList = new string[]{"Juice", "Coffee", 
		"Cereal & Milk", "Fruit Plate", "Toast & Jelly", 
		"Bagel & Cream Cheese"};
	string[] foodPrice = new string[]{"1.09", "1.09", "2.19", 
		"2.49", "1.49", "1.49"};

	for(int count=0; count < foodList.Length; count++)
	{
		ListViewItem listItem = new ListViewItem(foodList[count]);
		listItem.SubItems.Add(foodPrice[count]);
		ListView1.Items.Add(listItem);
	}
	this.Controls.Add(ListView1);
}

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft