ListView.SelectedIndexCollection Class
Represents the collection containing the indexes to the selected items in a list view control.
For a list of all members of this type, see ListView.SelectedIndexCollection Members.
System.Object
System.Windows.Forms.ListView.SelectedIndexCollection
[Visual Basic] Public Class ListView.SelectedIndexCollection Implements IList, ICollection, IEnumerable [C#] public class ListView.SelectedIndexCollection : IList, ICollection, IEnumerable [C++] public __gc class ListView.SelectedIndexCollection : public IList, ICollection, IEnumerable [JScript] public class ListView.SelectedIndexCollection implements IList, ICollection, IEnumerable
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Remarks
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 is an example of how the ListView.ListViewItemCollection stores the items of the ListView as well as 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 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 the position of the index in the ListView.SelectedIndexCollection.
Example
[Visual Basic, C#] The following code example demonstrates using the SelectedIndices property, the SelectedIndexChanged event and the System.Windows.Forms.SelectedIndexCollection class. To run this example paste the following code in 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 method. This example assumes the event-handling method is correctly associated with the SelectedIndexChanged event.
[Visual Basic] ' 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 Sub InitializeListView() Me.ListView1 = New System.Windows.Forms.ListView Me.ListView1.BackColor = System.Drawing.SystemColors.Control Me.ListView1.Dock = System.Windows.Forms.DockStyle.Top Me.ListView1.Location = New System.Drawing.Point(0, 0) Me.ListView1.Name = "ListView1" Me.ListView1.Size = New System.Drawing.Size(292, 130) Me.ListView1.TabIndex = 0 Me.ListView1.View = System.Windows.Forms.View.Details Me.ListView1.MultiSelect = True Me.ListView1.HideSelection = False ListView1.HeaderStyle = ColumnHeaderStyle.Nonclickable Dim columnHeader1 As New ColumnHeader With columnHeader1 .Text = "Breakfast Item" .TextAlign = HorizontalAlignment.Left .Width = 146 End With Dim columnHeader2 As New ColumnHeader With columnHeader2 .Text = "Price Each" .TextAlign = HorizontalAlignment.Center .Width = 142 End With Me.ListView1.Columns.Add(columnHeader1) Me.ListView1.Columns.Add(columnHeader2) Dim foodList() As String = New String() {"Juice", "Coffee", _ "Cereal & Milk", "Fruit Plate", "Toast & Jelly", _ "Bagel & Cream Cheese"} Dim foodPrice() As String = New String() {"1.09", "1.09", _ "2.19", "2.49", "1.49", "1.49"} Dim count As Integer For count = 0 To foodList.Length - 1 Dim listItem As New ListViewItem(foodList(count)) listItem.SubItems.Add(foodPrice(count)) ListView1.Items.Add(listItem) Next Me.Controls.Add(Me.ListView1) End Sub . . . ' Uses the SelectedIndices property to retrieve and tally the price of ' the selected menu items. Private Sub ListView1_SelectedIndexChanged_UsingIndices _ (ByVal sender As Object, ByVal e As System.EventArgs) _ Handles ListView1.SelectedIndexChanged Dim indexes As ListView.SelectedIndexCollection = _ Me.ListView1.SelectedIndices Dim index As Integer Dim price As Double = 0.0 For Each index In indexes price += Double.Parse(Me.ListView1.Items(index).SubItems(1).Text) Next ' Output the price to TextBox1. TextBox1.Text = CType(price, String) End Sub [C#] // 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(); }
[C++, JScript] No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter button
in the upper-left corner of the page.
Requirements
Namespace: System.Windows.Forms
Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
See Also
ListView.SelectedIndexCollection Members | System.Windows.Forms Namespace