ItemCollection ItemCollection ItemCollection Class
Definition
Holds the list of items that represent the content of an ItemsControl.
public : sealed class ItemCollection : IIterable, IObservableVector, IVectorpublic sealed class ItemCollection : IEnumerable, IObservableVector, IListPublic NotInheritable Class ItemCollection Implements IEnumerable, IObservableVector, IList
<ItemsControl>
oneOrMoreFrameworkElements
</ItemsControl>
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
Enumerating the collection in C# or Microsoft Visual Basic
An ItemCollection is enumerable, so you can use language-specific syntax such as foreach in C# to enumerate the items in the collection. The compiler does the type-casting for you and you won't need to cast to IEnumerable explicitly. If you do need to cast explicitly, for example if you want to call GetEnumerator, cast to IEnumerable<T> with an Object or FrameworkElement constraint.
Properties
Item[Int32] Item[Int32] Item[Int32]
Gets or sets the element at the specified index.
This member is not implemented in C++T this[int index] { get; set; }Property Item(index As Integer) As T
- index
The zero-based index of the element to get or set.
- Value
- T T T
The element at the specified index.
- Attributes
index is not a valid index in the System.Collections.Generic.IList`1.
The property is set and the System.Collections.Generic.IList`1 is read-only.
Methods
Append(Object) Append(Object) Append(Object)
Adds a new item to the collection.
public : void Append(PlatForm::Object value)This member is not implemented in C#This member is not implemented in VB.Net
- value
- PlatForm::Object Object Object
The new item to add.
- Attributes
Clear() Clear() Clear()
Removes all items from the collection.
public : void Clear()This member is not implemented in C#This member is not implemented in VB.Net
- Attributes
First() First() First()
Returns the iterator for iteration over the items in the collection.
public : IIterator<PlatForm::Object> First()This member is not implemented in C#This member is not implemented in VB.Net
The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.
- Attributes
GetAt(UInt32) GetAt(UInt32) GetAt(UInt32)
Returns the item located at the specified index.
public : PlatForm::Object GetAt(unsigned int index)This member is not implemented in C#This member is not implemented in VB.Net
- index
- unsigned int UInt32 UInt32
The integer index for the value to retrieve.
The item value at the specified index.
- Attributes
GetEnumerator() GetEnumerator() GetEnumerator()
Returns an enumerator that iterates through the collection.
This member is not implemented in C++IEnumerator<T> GetEnumerator()Function GetEnumerator As IEnumerator(Of T)
An enumerator that can be used to iterate through the collection.
- Attributes
GetMany(UInt32, Object[]) GetMany(UInt32, Object[]) GetMany(UInt32, Object[])
Retrieves multiple elements in a single pass through the iterator.
public : unsigned short GetMany(unsigned int startIndex, PlatForm::Object[] items)This member is not implemented in C#This member is not implemented in VB.Net
- startIndex
- unsigned int UInt32 UInt32
The index from which to start retrieval.
- items
- PlatForm::Object[] Object[] Object[]
Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved.
The number of items retrieved.
- Attributes
GetView() GetView() GetView()
Gets an immutable view into the collection.
public : IVectorView<PlatForm::Object> GetView()This member is not implemented in C#This member is not implemented in VB.Net
An object representing the immutable collection view.
- Attributes
IndexOf(T) IndexOf(T) IndexOf(T)
Determines the index of a specific item in the System.Collections.Generic.IList`1.
This member is not implemented in C++int IndexOf(T item)Function IndexOf(item As T) As Integer
- item
- T T T
The object to locate in the System.Collections.Generic.IList`1.
The index of item if found in the list; otherwise, -1.
- Attributes
IndexOf(Object, UInt32) IndexOf(Object, UInt32) IndexOf(Object, UInt32)
Retrieves the index of the specified item.
public : PlatForm::Boolean IndexOf(PlatForm::Object value, unsigned int index)This member is not implemented in C#This member is not implemented in VB.Net
- value
- PlatForm::Object Object Object
The value to find in the collection.
- index
- unsigned int UInt32 UInt32
The index of the item, if it is found.
true if an item with the specified value was found; otherwise, false.
- Attributes
Insert(Int32, T) Insert(Int32, T) Insert(Int32, T)
Inserts an item to the System.Collections.Generic.IList`1 at the specified index.
This member is not implemented in C++void Insert(int index, T item)Sub Insert(index As Integer, item As T)
- index
The zero-based index at which item should be inserted.
- item
- T T T
The object to insert into the System.Collections.Generic.IList`1.
- Attributes
index is not a valid index in the System.Collections.Generic.IList`1.
The System.Collections.Generic.IList`1 is read-only.
InsertAt(UInt32, Object) InsertAt(UInt32, Object) InsertAt(UInt32, Object)
Inserts the specified item at the specified index.
public : void InsertAt(unsigned int index, PlatForm::Object value)This member is not implemented in C#This member is not implemented in VB.Net
- index
- unsigned int UInt32 UInt32
The index at which to set the value.
- value
- PlatForm::Object Object Object
The value to set.
- Attributes
Remarks
InsertAt expands the collection and moves all subsequent index items by one.
RemoveAt(Int32) RemoveAt(Int32) RemoveAt(Int32)
Removes the System.Collections.Generic.IList`1 item at the specified index.
This member is not implemented in C++void RemoveAt(int index)Sub RemoveAt(index As Integer)
- index
The zero-based index of the item to remove.
- Attributes
index is not a valid index in the System.Collections.Generic.IList`1.
The System.Collections.Generic.IList`1 is read-only.
RemoveAt(UInt32) RemoveAt(UInt32) RemoveAt(UInt32)
Removes the item at the specified index.
public : void RemoveAt(unsigned int index)This member is not implemented in C#This member is not implemented in VB.Net
- index
- unsigned int UInt32 UInt32
The index position of the item to remove.
- Attributes
Remarks
If successful, calling this method reduces the collection size by one. Items with index values greater than the called index have their index values reduced by one.
RemoveAtEnd() RemoveAtEnd() RemoveAtEnd()
Removes the last item in the collection.
public : void RemoveAtEnd()This member is not implemented in C#This member is not implemented in VB.Net
- Attributes
ReplaceAll(Object[]) ReplaceAll(Object[]) ReplaceAll(Object[])
Initially clears the collection, then inserts the provided array as new items.
public : void ReplaceAll(PlatForm::Object[] items)This member is not implemented in C#This member is not implemented in VB.Net
- items
- PlatForm::Object[] Object[] Object[]
The new collection items.
- Attributes
Remarks
For implementations that track a "changed" event, the initial reset fires an event, but the items added don't fire discrete per-item events.
SetAt(UInt32, Object) SetAt(UInt32, Object) SetAt(UInt32, Object)
Sets the value at the specified index to the item value specified.
public : void SetAt(unsigned int index, PlatForm::Object value)This member is not implemented in C#This member is not implemented in VB.Net
- index
- unsigned int UInt32 UInt32
The index at which to set the value.
- value
- PlatForm::Object Object Object
The value to set.
- Attributes
Remarks
SetAt replaces the item at the index, and the collection count remains the same.