PointCollection PointCollection PointCollection Class

Definition

Represents a collection of Point values that can be individually accessed by index.

public : sealed class PointCollection : IIterable<Point>, IVector<Point>
public sealed class PointCollection : IEnumerable<Point>, IList<Point>
Public NotInheritable Class PointCollection Implements IEnumerable<Point>, IList<Point>
<object property="oneOrMorePoints"/>
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

A PointCollection 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<Point> explicitly. If you do need to cast explicitly, for example if you want to call GetEnumerator, cast to IEnumerable with a Point constraint.

Constructors

PointCollection() PointCollection() PointCollection()

Initializes a new instance of the PointCollection class.

public : PointCollection()
public PointCollection()
Public Sub New()

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(Point) Append(Point) Append(Point)

Adds a new item to the collection.

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

Adds a new item to the collection.

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 an iterator for the items in the collection.

public : IIterator<Point> 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 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 : Point 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 Point 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, Point[]) GetMany(UInt32, Point[]) GetMany(UInt32, Point[])

Retrieves multiple elements in a single pass through the iterator.

public : unsigned int GetMany(unsigned int startIndex, Point[] 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
Point[] Point[] Point[]

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.

Remarks

The GetMany method operates identically as if calling and for each element in the supplied array. This means that the first element returned by the GetMany method is the same element as returned by retrieving the property prior to calling GetMany. After the GetMany call returns, the property will retrieve the element following the last element returned by the GetMany call, or produce an error if no more elements exist in the sequences.

The GetMany method returns the actual number of elements returned. It must be the minimum of a) the number of elements remaining in the collection, or b) the number of elements requested, that is, "capacity". Therefore, whenever GetMany returns less than the number of elements requested, the end of the sequence has been reached. It returns the number of elements retrieved in the "actual" output parameter.

When the caller specifies a capacity of 0, the position of the iterator is unchanged. Elements in the array following the values returned are unchanged.

GetView() GetView() GetView()

Gets an immutable view into the collection.

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

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(Point, UInt32) IndexOf(Point, UInt32) IndexOf(Point, UInt32)

Retrieves the index of the specified item.

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

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, Point) InsertAt(UInt32, Point) InsertAt(UInt32, Point)

Inserts the specified item at the specified index.

public : void InsertAt(unsigned int index, Point 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
Point Point Point

The value to set.

Remarks

InsertAt expands the collection and moves all subsequent index items by one.

In contrast, SetAt replaces the item at the index, and the collection count remains the same.

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(Point[]) ReplaceAll(Point[]) ReplaceAll(Point[])

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

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

The new collection items.

SetAt(UInt32, Point) SetAt(UInt32, Point) SetAt(UInt32, Point)

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

public : void SetAt(unsigned int index, Point 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
Point Point Point

The value to set.

Remarks

InsertAt expands the collection and moves all subsequent index items by one.

In contrast, SetAt replaces the item at the index, and the collection count remains the same.

See Also