PathFigureCollection PathFigureCollection PathFigureCollection Class

Represents a collection of PathFigure objects that collectively make up the geometry of a PathGeometry.

Syntax

Declaration

public sealed class PathFigureCollectionpublic sealed class PathFigureCollectionPublic NotInheritable Class PathFigureCollection
<object>
  <object.property>
    oneOrMorePathFigures
  </object.property>
</object>

Remarks

Enumerating the collection in C# or Microsoft Visual Basic

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

Constructors summary

Initializes a new instance of the PathFigureCollection class.

Properties summary

Gets the size (count) of the collection.

Methods summary

Adds a new item to the collection.

Removes all items from the collection.

Returns an iterator for the items in the collection.

Returns the item located at the specified index.

Retrieves multiple elements in a single pass through the iterator.

Gets an immutable view into the collection.

Retrieves the index of the specified item.

Inserts the specified item at the specified index.

Removes the item at the specified index.

Removes the last item in the collection.

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

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

Constructors

  • PathFigureCollection()
    PathFigureCollection()
    PathFigureCollection()
    PathFigureCollection()

    Initializes a new instance of the PathFigureCollection class.

    public PathFigureCollection()public New()Public Sub New()public PathFigureCollection()

Properties

  • Size
    Size
    Size
    Size

    Gets the size (count) of the collection.

    public uint Size { get; }public uint Size { get; }Public ReadOnly Property Size As uintpublic uint Size { get; }

    Property Value

    • uint
      uint
      uint

      The count of items in the collection.

Methods

  • Append(PathFigure)
    Append(PathFigure)
    Append(PathFigure)
    Append(PathFigure)

    Adds a new item to the collection.

    public void Append(PathFigure value)public void Append(PathFigure value)Public Function Append(value As PathFigure) As voidpublic void Append(PathFigure value)

    Parameters

  • Clear()
    Clear()
    Clear()
    Clear()

    Removes all items from the collection.

    public void Clear()public void Clear()Public Function Clear() As voidpublic void Clear()
  • First()
    First()
    First()
    First()

    Returns an iterator for the items in the collection.

    public IIterator<PathFigure> First()public IIterator<PathFigure> First()Public Function First() As IIterator( Of PathFigure )public IIterator<PathFigure> First()

    Returns

    • The iterator. 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)
    GetAt(UInt32)

    Returns the item located at the specified index.

    public PathFigure GetAt(UInt32 index)public PathFigure GetAt(UInt32 index)Public Function GetAt(index As UInt32) As PathFigurepublic PathFigure GetAt(UInt32 index)

    Parameters

    • index
      System.UInt32
      System.UInt32
      System.UInt32

      The integer index for the value to retrieve.

    Returns

  • GetMany(UInt32, PathFigure[])
    GetMany(UInt32, PathFigure[])
    GetMany(UInt32, PathFigure[])
    GetMany(UInt32, PathFigure[])

    Retrieves multiple elements in a single pass through the iterator.

    public uint GetMany(UInt32 startIndex, PathFigure[] items)public uint GetMany(UInt32 startIndex, PathFigure[] items)Public Function GetMany(startIndex As UInt32, items As PathFigure[]) As uintpublic uint GetMany(UInt32 startIndex, PathFigure[] items)

    Parameters

    • startIndex
      System.UInt32
      System.UInt32
      System.UInt32

      The index from which to start retrieval.

    • items
      Windows.UI.Xaml.Media.PathFigure[]
      Windows.UI.Xaml.Media.PathFigure[]
      Windows.UI.Xaml.Media.PathFigure[]

      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.

  • GetView()
    GetView()
    GetView()
    GetView()

    Gets an immutable view into the collection.

    public IVectorView<PathFigure> GetView()public IVectorView<PathFigure> GetView()Public Function GetView() As IVectorView( Of PathFigure )public IVectorView<PathFigure> GetView()

    Returns

    • An object representing the immutable collection view.

  • IndexOf(PathFigure, UInt32)
    IndexOf(PathFigure, UInt32)
    IndexOf(PathFigure, UInt32)
    IndexOf(PathFigure, UInt32)

    Retrieves the index of the specified item.

    public bool IndexOf(PathFigure value, UInt32 index)public bool IndexOf(PathFigure value, UInt32 index)Public Function IndexOf(value As PathFigure, index As UInt32) As boolpublic bool IndexOf(PathFigure value, UInt32 index)

    Parameters

    • value

      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.

  • InsertAt(UInt32, PathFigure)
    InsertAt(UInt32, PathFigure)
    InsertAt(UInt32, PathFigure)
    InsertAt(UInt32, PathFigure)

    Inserts the specified item at the specified index.

    public void InsertAt(UInt32 index, PathFigure value)public void InsertAt(UInt32 index, PathFigure value)Public Function InsertAt(index As UInt32, value As PathFigure) As voidpublic void InsertAt(UInt32 index, PathFigure value)

    Parameters

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

    Removes the item at the specified index.

    public void RemoveAt(UInt32 index)public void RemoveAt(UInt32 index)Public Function RemoveAt(index As UInt32) As voidpublic void RemoveAt(UInt32 index)

    Parameters

    • index
      System.UInt32
      System.UInt32
      System.UInt32

      The index position of the item to remove.

  • RemoveAtEnd()
    RemoveAtEnd()
    RemoveAtEnd()
    RemoveAtEnd()

    Removes the last item in the collection.

    public void RemoveAtEnd()public void RemoveAtEnd()Public Function RemoveAtEnd() As voidpublic void RemoveAtEnd()
  • ReplaceAll(PathFigure[])
    ReplaceAll(PathFigure[])
    ReplaceAll(PathFigure[])
    ReplaceAll(PathFigure[])

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

    public void ReplaceAll(PathFigure[] items)public void ReplaceAll(PathFigure[] items)Public Function ReplaceAll(items As PathFigure[]) As voidpublic void ReplaceAll(PathFigure[] items)

    Parameters

    • items
      Windows.UI.Xaml.Media.PathFigure[]
      Windows.UI.Xaml.Media.PathFigure[]
      Windows.UI.Xaml.Media.PathFigure[]

      The new collection items.

  • SetAt(UInt32, PathFigure)
    SetAt(UInt32, PathFigure)
    SetAt(UInt32, PathFigure)
    SetAt(UInt32, PathFigure)

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

    public void SetAt(UInt32 index, PathFigure value)public void SetAt(UInt32 index, PathFigure value)Public Function SetAt(index As UInt32, value As PathFigure) As voidpublic void SetAt(UInt32 index, PathFigure value)

    Parameters

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ActivatableAttribute
Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.ThreadingAttribute
Windows.Foundation.Metadata.WebHostHiddenAttribute

Details

Assembly

Windows.UI.Xaml.Media.dll