CheckedIndexCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.1.0.0)
Represents the collection containing the indexes to the checked items in a list view control.
- C#
- VB.NET
public class CheckedIndexCollection : IList<Int32>, ICollection<Int32>, IEnumerable<Int32>, IEnumerable
Public Class CheckedIndexCollection
Inherits IList(Of Int32)
Implements ICollection(Of Int32), IEnumerable(Of Int32), IEnumerable
Properties
Count
Int32: Returns the number of items in the collection.
IsReadOnly
Boolean: Returns whether the collection is read-only.
Item(index)
Int32: Returns the index 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 CheckedIndexCollection.
Methods
Add(index)
Adds the item at the specified index in the Items collection to the CheckedIndexCollection.
| Parameter | Type | Description |
|---|---|---|
| index | Int32 | The index of the item in the Items collection to add to the CheckedIndexCollection. |
Returns: Int32. The new count of selected items.
Throws:
- ArgumentOutOfRangeException The specified index is less than 0 or greater than or equal to the number of items in the owner ListView. Or The owner ListView is in virtual mode, and the specified index is less than 0 or greater than or equal to the value of VirtualListSize.
Clear()
Clears the selection.
Contains(checkedIndex)
Determines whether the specified index is located in the collection.
| Parameter | Type | Description |
|---|---|---|
| checkedIndex | Int32 | The index of the checked item 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.
CopyTo(array, index)
Copies the list of checked indexes into the specified array starting at the specified index .
| Parameter | Type | Description |
|---|---|---|
| array | Int32[] | Array that will received the list of selected indexes. |
| index | Int32 | Starting index in array . |
GetEnumerator()
Returns an enumerator that can be used to iterate through the checked index collection.
Returns: IEnumerator<Int32>. An IEnumerator that represents the checked index collection.
IndexOf(checkedIndex)
Returns the index within the CheckedIndexCollection of the specified index from the ListViewItemCollection of the list view control.
| Parameter | Type | Description |
|---|---|---|
| checkedIndex | Int32 | The zero-based index from the ListViewItemCollection to locate in the collection. |
Returns: Int32. The zero-based index in the collection where the specified index of the ListViewItemCollection is located within the CheckedIndexCollection; otherwise, -1 if the index is not located in the collection.
Remove(index)
Removes the item at the specified index in the Items collection from the CheckedIndexCollection.
| Parameter | Type | Description |
|---|---|---|
| index | Int32 | The index of the item in the Items collection to remove from the CheckedIndexCollection. |
Throws:
- ArgumentOutOfRangeException The specified index is less than 0 or greater than or equal to the number of items in the owner ListView. Or The owner ListView is in virtual mode, and the specified index is less than 0 or greater than or equal to the value of VirtualListSize.