IXRPathFigureCollection (Compact 2013)

3/28/2014

This class represents a collection of IXRPathFigure objects that collectively make up the geometry of an IXRPathGeometry object.

Syntax

class IXRPathFigureCollection : public IXRDependencyObject

Inheritance Hierarchy

IXRDependencyObject

    IXRPathFigureCollection

Methods

Method

Description

IXRPathFigureCollection::Add

Adds an item to the end of this collection and retrieves the index of where it was added.

IXRPathFigureCollection::Clear

Removes all items from this collection.

IXRPathFigureCollection::Contains

Determines whether an item is in this collection.

IXRPathFigureCollection::GetCount

Retrieves the number of items in this collection.

IXRPathFigureCollection::GetItem

Retrieves the item at the specified index in this collection.

IXRPathFigureCollection::IndexOf

Searches for the specified item and retrieves the zero-based index of its occurrence within this collection.

IXRPathFigureCollection::Insert

Inserts an item into this collection at the location that has the specified index value.

IXRPathFigureCollection::Remove

Removes a specific item from this collection.

IXRPathFigureCollection::RemoveAt

Removes the item at the specified index from this collection.

Thread Safety

Members of this class are thread safe if you previously called IXRApplication::CreateHostFromXaml and supplied it with an XRWindowCreateParams structure that has AllowsMultipleThreadAccess set to true. Allowing multiple-thread access can have a significant impact on application performance because this option serializes data for all objects in the collection across threads. If you have control over the lifetimes of these objects, it is recommended that you serialize only what is needed to achieve optimal performance.

Remarks

Use IXRPathFigureCollection to store IXRPathFigure information for an IXRPathGeometry object. This collection contains information that together defines the geometric shape of a path object drawn on-screen.

To obtain a pointer to this collection, call IXRPathGeometry::GetFigures. Then, use the methods of this class to add, remove, or retrieve items. To clear the complete collection, call the IXRPathFigureCollection::Clear method.

You can also create a new collection. To do this, use the IXRApplication::CreateObject(IID,Object) method to create an empty IXRPathFigureCollection object. Then, use CreateObject to create multiple IXRPathFigure objects that each represent a subsection of geometry in a path object. Next, add each IXRPathFigure value to the IXRPathFigureCollection collection by calling the IXRPathFigureCollection::Add method. And finally, set the new collection for an IXRPathGeometry object by calling IXRPathGeometry::SetFigures.

When you create a class instance, use an IXRPathFigureCollectionPtr smart pointer instead of a raw interface pointer. For more information, see XRPtr<Interface>.

You can also define a path-figure collection in Microsoft Silverlight 3 XAML. For information about the differences between XAML in XAML for Windows Embedded and Silverlight 3, see Differences Between Microsoft Silverlight 3 and XAML for Windows Embedded. For more information about how to define this collection in the source XAML for your application, see the PathFigureCollection Class on MSDN.

.NET Framework Equivalent

System.Windows.Media.PathFigureCollection

Requirements

Header

XamlRuntime.h

sysgen

SYSGEN_XAML_RUNTIME

See Also

Reference

Classes for Collection Management
IXRPathGeometry::SetFigures
IXRPathGeometry::GetFigures