Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

ListViewItem.ListViewSubItemCollection Class

.NET Framework 4

Represents a collection of ListViewItem.ListViewSubItem objects stored in a ListViewItem.

System.Object
  System.Windows.Forms.ListViewItem.ListViewSubItemCollection

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
C#
C++
F#
VB
Copy 
public class ListViewSubItemCollection : IList, 
	ICollection, IEnumerable

The ListViewItem.ListViewSubItemCollection type exposes the following members.

  Name Description
Public method ListViewItem.ListViewSubItemCollection Initializes a new instance of the ListViewItem.ListViewSubItemCollection class.
Top
  Name Description
Public property Count Gets the number of subitems in the collection.
Public property IsReadOnly Gets a value indicating whether the collection is read-only.
Public property Item[Int32] Gets or sets the subitem at the specified index within the collection.
Public property Item[String] Gets an item with the specified key from the collection.
Top
  Name Description
Public method Add(ListViewItem.ListViewSubItem) Adds an existing ListViewItem.ListViewSubItem to the collection.
Public method Add(String) Adds a subitem to the collection with specified text.
Public method Add(String, Color, Color, Font) Adds a subitem to the collection with specified text, foreground color, background color, and font settings.
Public method AddRange(ListViewItem.ListViewSubItem[]) Adds an array of ListViewItem.ListViewSubItem objects to the collection.
Public method AddRange(String[]) Creates new subitems based on an array and adds them to the collection.
Public method AddRange(String[], Color, Color, Font) Creates new subitems based on an array and adds them to the collection with specified foreground color, background color, and font.
Public method Clear Removes all subitems and the parent ListViewItem from the collection.
Public method Contains Determines whether the specified subitem is located in the collection.
Public method ContainsKey Determines if the collection contains an item with the specified key.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEnumerator Returns an enumerator to use to iterate through the subitem collection.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IndexOf Returns the index within the collection of the specified subitem.
Public method IndexOfKey Returns the index of the first occurrence of an item with the specified key within the collection.
Public method Insert Inserts a subitem into the collection at the specified index.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Remove Removes a specified item from the collection.
Public method RemoveAt Removes the subitem at the specified index within the collection.
Public method RemoveByKey Removes an item with the specified key from the collection.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public Extension Method AsParallel Enables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension Method AsQueryable Converts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension Method Cast<TResult> Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension Method OfType<TResult> Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Top
  Name Description
Explicit interface implemetation Private method ICollection.CopyTo Infrastructure. Copies the item and collection of subitems into an array.
Explicit interface implemetation Private property ICollection.IsSynchronized Infrastructure. Gets a value indicating whether access to the collection is synchronized (thread safe).
Explicit interface implemetation Private property ICollection.SyncRoot Infrastructure. Gets an object that can be used to synchronize access to the collection.
Explicit interface implemetation Private method IList.Add Infrastructure. Adds an existing ListViewItem.ListViewSubItem to the collection.
Explicit interface implemetation Private method IList.Contains Infrastructure. Determines whether the specified subitem is located in the collection.
Explicit interface implemetation Private method IList.IndexOf Infrastructure. Returns the index within the collection of the specified subitem.
Explicit interface implemetation Private method IList.Insert Infrastructure. Inserts a subitem into the collection at the specified index.
Explicit interface implemetation Private property IList.IsFixedSize Infrastructure. Gets a value indicating whether the collection has a fixed size.
Explicit interface implemetation Private property IList.Item Infrastructure. Gets or sets the ListViewItem.ListViewSubItem at the specified index within the collection.
Explicit interface implemetation Private method IList.Remove Removes a specified item from the collection.
Top

A ListViewItem.ListViewSubItemCollection stores ListViewItem.ListViewSubItem objects that represent subitems of a parent ListViewItem in the ListView control. Subitems are only displayed in a ListView control when columns are specified in the Columns property of the ListView control and when the View property of the ListView control is set to Details. The order of subitems in the ListViewItem.ListViewSubItemCollection determines the columns the subitems are displayed in the ListView control.

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

In addition to methods and properties for adding and removing subitems, the ListViewItem.ListViewSubItemCollection also provides methods to find subitems in the collection. The Contains method enables you to determine whether a ListViewItem.ListViewSubItem is a member of the collection. Once you know that the subitem is located in the collection, you can use the IndexOf method to determine where the subitem is located in the collection.

.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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ