BlockCollection BlockCollection BlockCollection Class

Definition

Represents a collection of Block elements.

public : sealed class BlockCollection : IIterable<Block>, IVector<Block>
public sealed class BlockCollection : IEnumerable<Block>, IList<Block>
Public NotInheritable Class BlockCollection Implements IEnumerable<Block>, IList<Block>
Attributes
Windows 10 requirements
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

You can iterate through a BlockCollection object in C# or Microsoft Visual Basic. In many cases, such as using foreach syntax, the compiler does this casting for you and you won't need to cast to IEnumerable<Block> explicitly. If you do need to cast explicitly, for example if you want to call GetEnumerator, cast the collection object to IEnumerable with a Block constraint.

Properties

Item[Int32] 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
T this[int index] { get; set; }
Parameters
index

The zero-based index of the element to get or set.

Value
T T T

The element at the specified index.

Exceptions

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.

Size Size Size

Gets the size (count) of the collection.

public : unsigned int Size { get; }
This member is not implemented in C#
This member is not implemented in VB.Net
Value
unsigned int uint uint

The count of items in the collection.

Methods

Append(Block) Append(Block) Append(Block)

Adds a new item to the collection.

public : void Append(Block value)
This member is not implemented in C#
This member is not implemented in VB.Net
Parameters
value
Block Block Block

The new item to add.

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

First() First() First()

Returns the iterator for iteration over the items in the collection.

public : IIterator<Block> First()
This member is not implemented in C#
This member is not implemented in VB.Net
Returns

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

GetAt(UInt32) GetAt(UInt32) GetAt(UInt32)

Returns the item located at the specified index.

public : Block GetAt(unsigned int index)
This member is not implemented in C#
This member is not implemented in VB.Net
Parameters
index
unsigned int UInt32 UInt32

The integer index for the value to retrieve.

Returns

The Block value at the specified index.

GetEnumerator() 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)
IEnumerator<T> GetEnumerator()
Returns

An enumerator that can be used to iterate through the collection.

GetMany(UInt32, Block[]) GetMany(UInt32, Block[]) GetMany(UInt32, Block[])

Retrieves multiple elements in a single pass through the iterator.

public : unsigned int GetMany(unsigned int startIndex, Block[] items)
This member is not implemented in C#
This member is not implemented in VB.Net
Parameters
startIndex
unsigned int UInt32 UInt32

The index from which to start retrieval.

items
Block[] Block[] Block[]

Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved.

Returns
unsigned int uint uint

The number of items retrieved.

GetView() GetView() GetView()

Gets an immutable view into the collection.

public : IVectorView<Block> GetView()
This member is not implemented in C#
This member is not implemented in VB.Net
Returns
IVectorView<Block> IReadOnlyList<Block> IReadOnlyList<Block>

An object representing the immutable collection view.

IndexOf(T) 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
int IndexOf(T item)
Parameters
item
T T T

The object to locate in the System.Collections.Generic.IList`1.

Returns

The index of item if found in the list; otherwise, -1.

IndexOf(Block, UInt32) IndexOf(Block, UInt32) IndexOf(Block, UInt32)

Retrieves the index of the specified item.

public : Platform::Boolean IndexOf(Block value, unsigned int index)
This member is not implemented in C#
This member is not implemented in VB.Net
Parameters
value
Block Block Block

The value to find in the collection.

index
unsigned int UInt32 UInt32

The index of the item to find, if found.

Returns
Platform::Boolean bool bool

true if an item with the specified value was found; otherwise, false.

Insert(Int32, T) 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)
void Insert(int index, T item)
Parameters
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.

Exceptions

index is not a valid index in the System.Collections.Generic.IList`1.

The System.Collections.Generic.IList`1 is read-only.

InsertAt(UInt32, Block) InsertAt(UInt32, Block) InsertAt(UInt32, Block)

Inserts the specified item at the specified index.

public : void InsertAt(unsigned int index, Block value)
This member is not implemented in C#
This member is not implemented in VB.Net
Parameters
index
unsigned int UInt32 UInt32

The index at which to set the value.

value
Block Block Block

The value to set.

RemoveAt(Int32) 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)
void RemoveAt(int index)
Parameters
index

The zero-based index of the item to remove.

Exceptions

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
Parameters
index
unsigned int UInt32 UInt32

The index position of the item to remove.

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

ReplaceAll(Block[]) ReplaceAll(Block[]) ReplaceAll(Block[])

Initially clears the collection, then inserts the provided array as new items.

public : void ReplaceAll(Block[] items)
This member is not implemented in C#
This member is not implemented in VB.Net
Parameters
items
Block[] Block[] Block[]

The new collection items.

SetAt(UInt32, Block) SetAt(UInt32, Block) SetAt(UInt32, Block)

Sets the value at the specified index to the Block value specified.

public : void SetAt(unsigned int index, Block value)
This member is not implemented in C#
This member is not implemented in VB.Net
Parameters
index
unsigned int UInt32 UInt32

The index at which to set the value.

value
Block Block Block

The value to set.

See Also