ListView.CheckedIndexCollection Class

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Represents the collection containing the indexes to the checked items in a list view control.

public: ref class ListView::CheckedIndexCollection : System::Collections::IList

[System.ComponentModel.ListBindable(false)]
public class ListView.CheckedIndexCollection : System.Collections.IList

[<System.ComponentModel.ListBindable(false)>]
type ListView.CheckedIndexCollection = class
    interface IList
    interface ICollection
    interface IEnumerable

Public Class ListView.CheckedIndexCollection
Implements IList

Inheritance

Object

ListView.CheckedIndexCollection

Attributes

ListBindableAttribute

Implements

ICollection IEnumerable IList

Remarks

A ListView.CheckedIndexCollection stores the indexes to the checked items in a ListView control. Items can be checked only if the CheckBoxes property of the ListView control is set to true. The indexes stored in the ListView.CheckedIndexCollection 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 checked states in an example ListView control.

Index	Item	Checked state in the ListView
0	Item1	Unchecked
1	Item2	Checked
2	Item3	Unchecked
3	Item4	Checked
4	Item5	Checked

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

Index	Index of checked 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.CheckedIndexCollection. 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.CheckedIndexCollection.

Constructors

ListView.CheckedIndexCollection(ListView)

Initializes a new instance of the ListView.CheckedIndexCollection class.

Properties

Count	Gets the number of items in the collection.
IsReadOnly	Gets a value indicating whether the collection is read-only.
Item[Int32]	Gets the index value at the specified index within the collection.

Methods

Contains(Int32)	Determines whether the specified index is located in the collection.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetEnumerator()	Returns an enumerator that can be used to iterate through the checked index collection.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IndexOf(Int32)	Returns the index within the ListView.CheckedIndexCollection of the specified index from the ListView.ListViewItemCollection of the list view control.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)	Copies the collection of checked-item indexes into an array.
ICollection.IsSynchronized	Gets a value indicating whether access to the collection is synchronized (thread safe).
ICollection.SyncRoot	Gets an object that can be used to synchronize access to the collection of controls.
IList.Add(Object)	Adds an item to the collection.
IList.Clear()	Removes all items from the collection.
IList.Contains(Object)	Checks whether the index corresponding with the ListViewItem is checked.
IList.IndexOf(Object)	Returns the index of the specified object in the ListView.CheckedIndexCollection.
IList.Insert(Int32, Object)	Inserts an item into the collection at a specified index.
IList.IsFixedSize	Gets a value indicating whether the ListView.CheckedIndexCollection has a fixed size.
IList.Item[Int32]	Gets or sets an object in the ListView.CheckedIndexCollection.
IList.Remove(Object)	Removes the first occurrence of an item from the collection.
IList.RemoveAt(Int32)	Removes an item from the collection at a specified index.

Extension Methods

See also

• ListView.ListViewItemCollection