ListView.SelectedIndexCollection Class

Represents the collection that contains the indexes to the selected items in a ListView control.

System.Object
  System.Windows.Forms.ListView.SelectedIndexCollection

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

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

The ListView.SelectedIndexCollection type exposes the following members.

  NameDescription
Public methodListView.SelectedIndexCollectionInitializes a new instance of the ListView.SelectedIndexCollection class.
Top

  NameDescription
Public propertyCountGets the number of items in the collection.
Public propertyIsReadOnlyGets a value indicating whether the collection is read-only.
Public propertyItemGets the index value at the specified index within the collection.
Top

  NameDescription
Public methodAddAdds the item at the specified index in the Items array to the collection.
Public methodClearClears the items in the collection.
Public methodContainsDetermines whether the specified index is located in the collection.
Public methodCopyToCopies the entire collection into an existing array at a specified location within the array.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEnumeratorReturns an enumerator that can be used to iterate through the selected index collection.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfReturns the index within the ListView.SelectedIndexCollection of the specified index from the ListView.ListViewItemCollection of the ListView control.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRemoveRemoves the item at the specified index in the Items collection from the ListView.SelectedIndexCollection.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public Extension MethodAsParallelEnables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension MethodAsQueryableConverts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension MethodCast<TResult>Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension MethodOfType<TResult>Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Top

  NameDescription
Explicit interface implemetationPrivate propertyICollection.IsSynchronizedInfrastructure. Gets a value indicating whether access to the collection is synchronized (thread safe).
Explicit interface implemetationPrivate propertyICollection.SyncRootInfrastructure. Gets an object that can be used to synchronize access to the collection of controls.
Explicit interface implemetationPrivate methodIList.AddInfrastructure. Adds an item to the collection.
Explicit interface implemetationPrivate methodIList.ClearInfrastructure. Removes all items from the collection.
Explicit interface implemetationPrivate methodIList.ContainsInfrastructure. Determines whether the specified item is located in the collection.
Explicit interface implemetationPrivate methodIList.IndexOfInfrastructure. Returns the index in the ListView.SelectedIndexCollection. The ListView.SelectedIndexCollection contains the indexes of selected items in the ListView.ListViewItemCollection of the ListView control.
Explicit interface implemetationPrivate methodIList.InsertInfrastructure. Inserts an item into the collection at a specified index.
Explicit interface implemetationPrivate propertyIList.IsFixedSizeInfrastructure. Gets a value indicating whether the ListView.SelectedIndexCollection has a fixed size.
Explicit interface implemetationPrivate propertyIList.ItemInfrastructure. Gets or sets an object in the collection.
Explicit interface implemetationPrivate methodIList.RemoveInfrastructure. Removes the first occurrence of a specified item from the collection.
Explicit interface implemetationPrivate methodIList.RemoveAtInfrastructure. Removes an item from the collection at a specified index.
Top

A ListView.SelectedIndexCollection stores the indexes to the selected items in a ListView control. The indexes stored in the ListView.SelectedIndexCollection are index positions within the ListView.ListViewItemCollection. The ListView.ListViewItemCollection stores all items displayed in the ListView control.

The following table shows an example of how the ListView.ListViewItemCollection stores the items of the ListView and shows their selection states in an example ListView.

Index

Item

Selection state in the ListView

0

Item1

Unselected

1

Item2

Selected

2

Item3

Unselected

3

Item4

Selected

4

Item5

Selected

Based on the ListView.ListViewItemCollection example in the previous table, the following table demonstrates how the ListView.SelectedIndexCollection would appear.

Index

Index of selected item in the ListViewItemCollection

0

1

1

3

2

4

You can use the properties and methods of this class to perform a variety of tasks with the collection. The Contains method enables you to determine whether an index position from the ListView.ListViewItemCollection is one of the indexes stored in the ListView.SelectedIndexCollection. Once you know that the item is in the collection, you can use the IndexOf method to determine the position of the index in the ListView.SelectedIndexCollection.

The following code example demonstrates how to use the SelectedIndices, SelectedIndexChanged, and HeaderStyle members and the ListView.SelectedIndexCollection class. 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 example requires that the event handler is correctly associated with the SelectedIndexChanged event.

	// 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);
	}
	


...


	// Uses the SelectedIndices property to retrieve and tally the   
	// price of the selected menu items. 
	private void ListView1_SelectedIndexChanged_UsingIndices(
		object sender, System.EventArgs e)
	{

		ListView.SelectedIndexCollection indexes = 
			this.ListView1.SelectedIndices;
		
		double price = 0.0;
		foreach ( int index in indexes )
		{
			price += Double.Parse(
				this.ListView1.Items[index].SubItems[1].Text);
		}

		// Output the price to TextBox1.
		TextBox1.Text =  price.ToString();
	}
ListView.SelectIndices, SelectedIndexCollection, ListView.SelectedIndexChanged event, 

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft