Path​Segment​Collection Path​Segment​Collection Path​Segment​Collection Class

Definition

Represents a collection of PathSegment objects that can be individually accessed by index.

public sealed class PathSegmentCollection : IIterable, IVectorpublic sealed class PathSegmentCollection : IEnumerable, IListPublic NotInheritable Class PathSegmentCollection Implements IEnumerable, IList
<object>
  <object.property>
    oneOrMorePathSegments
  </object.property>
</object>
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

This class is relevant for setting the vector data for either a Path or a PathIcon.

Rather than creating an instance or an object element, you can also define different types of segments as part of a vector within the string for a Move and draw commands syntax.

Enumerating the collection in C# or Microsoft Visual Basic

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

Constructors

PathSegmentCollection() PathSegmentCollection() PathSegmentCollection()

Initializes a new instance of the PathSegmentCollection class.

public PathSegmentCollection()public PathSegmentCollection()Public Sub New()
Attributes

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
Parameters
index
System.Int32 System.Int32 System.Int32

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

Value
T T T

The element at the specified index.

Attributes
Exceptions
System.ArgumentOutOfRangeException System.ArgumentOutOfRangeException System.ArgumentOutOfRangeException

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

System.NotSupportedException System.NotSupportedException System.NotSupportedException

The property is set and the System.Collections.Generic.IList`1 is read-only.

See Also
System.Collections.Generic.ICollection<T>.IsReadOnlySystem.Collections.Generic.ICollection<T>.IsReadOnlySystem.Collections.Generic.ICollection<T>.IsReadOnly

Size Size Size

Gets the size (count) of the collection.

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

The count of items in the collection.

Attributes

Methods

Append(PathSegment) Append(PathSegment) Append(PathSegment)

Adds a new item to the collection.

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

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

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

The iterator. The iterator's current position is 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 PathSegment GetAt(UInt32 index)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
System.UInt32 System.UInt32 System.UInt32

The integer index for the value to retrieve.

Returns

The PathSegment 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)
Returns
System.Collections.Generic.IEnumerator<T> System.Collections.Generic.IEnumerator<T> System.Collections.Generic.IEnumerator<T>

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

Attributes
See Also
System.Collections.Generic.IEnumerator<T>System.Collections.Generic.IEnumerator<T>System.Collections.Generic.IEnumerator<T>

GetMany(UInt32, PathSegment[]) GetMany(UInt32, PathSegment[]) GetMany(UInt32, PathSegment[])

Retrieves multiple elements in a single pass through the iterator.

public unsigned short GetMany(UInt32 startIndex, PathSegment[] items)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
startIndex
System.UInt32 System.UInt32 System.UInt32

The index from which to start retrieval.

items
Windows.UI.Xaml.Media.PathSegment[] Windows.UI.Xaml.Media.PathSegment[] Windows.UI.Xaml.Media.PathSegment[]

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
uint uint uint

The number of items retrieved.

Attributes

GetView() GetView() GetView()

Gets an immutable view into the collection.

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

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
Parameters
item
T T T

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

Returns
System.Int32 System.Int32 System.Int32

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

Attributes

IndexOf(PathSegment, UInt32) IndexOf(PathSegment, UInt32) IndexOf(PathSegment, UInt32)

Retrieves the index of the specified item.

public PlatForm::Boolean IndexOf(PathSegment value, UInt32 index)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
value
PathSegment PathSegment PathSegment

The value to find in the collection.

index
System.UInt32 System.UInt32 System.UInt32

The index of the item to find, if found.

Returns
bool bool bool

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)
Parameters
index
System.Int32 System.Int32 System.Int32

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
Exceptions
System.ArgumentOutOfRangeException System.ArgumentOutOfRangeException System.ArgumentOutOfRangeException

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

System.NotSupportedException System.NotSupportedException System.NotSupportedException

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

See Also
System.Collections.Generic.ICollection<T>.IsReadOnlySystem.Collections.Generic.ICollection<T>.IsReadOnlySystem.Collections.Generic.ICollection<T>.IsReadOnly

InsertAt(UInt32, PathSegment) InsertAt(UInt32, PathSegment) InsertAt(UInt32, PathSegment)

Inserts the specified item at the specified index.

public void InsertAt(UInt32 index, PathSegment value)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
System.UInt32 System.UInt32 System.UInt32

The index at which to set the value.

value
PathSegment PathSegment PathSegment

The value to set.

Attributes

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)
Parameters
index
System.Int32 System.Int32 System.Int32

The zero-based index of the item to remove.

Attributes
Exceptions
System.ArgumentOutOfRangeException System.ArgumentOutOfRangeException System.ArgumentOutOfRangeException

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

System.NotSupportedException System.NotSupportedException System.NotSupportedException

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

See Also
System.Collections.Generic.ICollection<T>.IsReadOnlySystem.Collections.Generic.ICollection<T>.IsReadOnlySystem.Collections.Generic.ICollection<T>.IsReadOnly

RemoveAt(UInt32) RemoveAt(UInt32) RemoveAt(UInt32)

Removes the item at the specified index.

public void RemoveAt(UInt32 index)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
System.UInt32 System.UInt32 System.UInt32

The index position of the item to remove.

Attributes

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

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

public void ReplaceAll(PathSegment[] items)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
items
Windows.UI.Xaml.Media.PathSegment[] Windows.UI.Xaml.Media.PathSegment[] Windows.UI.Xaml.Media.PathSegment[]

The new collection items.

Attributes

SetAt(UInt32, PathSegment) SetAt(UInt32, PathSegment) SetAt(UInt32, PathSegment)

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

public void SetAt(UInt32 index, PathSegment value)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
System.UInt32 System.UInt32 System.UInt32

The index at which to set the value.

value
PathSegment PathSegment PathSegment

The value to set.

Attributes

See Also