SelectedListViewItemCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

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

C#

public class SelectedListViewItemCollection : IList<ListViewItem>, ICollection<ListViewItem>, IEnumerable<ListViewItem>, IEnumerable, IList, ICollection

VB.NET

Public Class SelectedListViewItemCollection
    Inherits IList(Of ListViewItem)
    Implements ICollection(Of ListViewItem), IEnumerable(Of ListViewItem), IEnumerable, IList, ICollection

Constructors

SelectedListViewItemCollection(owner)

Initializes a new instance of the SelectedListViewItemCollection class.

Name	Type	Description
owner	ListView	A ListView control that owns the collection.

Properties

Count

Int32: Returns the number of items in the collection.

IsReadOnly

Boolean: Returns whether the collection is read-only.

Item(index)

ListViewItem: Returns the item value at the specified index within the collection.

Throws:

• ArgumentOutOfRangeException The index parameter is less than 0 or greater than or equal to the value of the Count property of SelectedListViewItemCollection.

Item(key)

ListViewItem: Returns the item with the specified key within the collection.

Methods

Add(item)

Adds the specified item in the Items collection to the SelectedItems collection.

Parameter	Type	Description
item	ListViewItem	The item in the Items collection to add to the SelectedItems collection.

Returns: Int32. The new count of selected items.

Throws:

• ArgumentNullException item is null.
• ArgumentException item doesn't belongs to a different ListView.

Clear()

Clears the selection.

Contains(item)

Determines whether the specified item is located in the collection.

Parameter	Type	Description
item	ListViewItem	The ListViewItem to locate in the collection.

Returns: Boolean. true if the specified index from the ListViewItemCollection for the ListView is an item in the collection; otherwise, false.

ContainsKey(key)

Determines if an item with the specified key is contained in the collection.

Parameter	Type	Description
key	String	The name of the item to search for.

Returns: Boolean. true if an item with the specified key is contained in the collection; otherwise, false.

GetEnumerator()

Returns an enumerator that can be used to iterate through the checked index collection.

Returns: IEnumerator<ListViewItem>. An IEnumerator that represents the checked index collection.

IndexOf(item)

Returns the index within the SelectedListViewItemCollection of the specified item.

Parameter	Type	Description
item	ListViewItem	The ListViewItem to locate in the collection.

Returns: Int32. The zero-based index in the collection; otherwise, -1 if the item is not located in the collection.

IndexOfKey(key)

Determines the index of an item with the specified key.

Parameter	Type	Description
key	String	The name of the item to retrieve the index for.

Returns: Int32. The zero-based index for the ListViewItem with the specified name, if found; otherwise, -1.

Remove(item)

Removes the item in the Items collection from the SelectedItems collection.

Parameter	Type	Description
item	ListViewItem	The item in the Items collection to remove from the SelectedItems collection.