Export (0) Print
Expand All

PathGeometry Class

Represents a complex shape that may be composed of arcs, curves, ellipses, lines, and rectangles.

Namespace:  System.Windows.Media
Assembly:  PresentationCore (in PresentationCore.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

[ContentPropertyAttribute("Figures")]
public sealed class PathGeometry : Geometry
<PathGeometry>
  Figures
</PathGeometry>

The PathGeometry type exposes the following members.

  NameDescription
Public methodPathGeometry() Initializes a new instance of the PathGeometry class.
Public methodPathGeometry(IEnumerable<PathFigure>)Initializes a new instance of the PathGeometry class with the specified Figures.
Public methodPathGeometry(IEnumerable<PathFigure>, FillRule, Transform)Initializes a new instance of the PathGeometry class with the specified Figures, FillRule, and Transform.
Top

  NameDescription
Public propertyBounds Gets a Rect that specifies the bounding box of this PathGeometry object. Note: This method does not take any pens into account. (Overrides Geometry.Bounds.)
Public propertyCanFreezeGets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)
Public propertyDependencyObjectTypeGets the DependencyObjectType that wraps the CLR type of this instance.  (Inherited from DependencyObject.)
Public propertyDispatcherGets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public propertyFigures Gets or sets the collection of PathFigure objects that describe the path's contents.
Public propertyFillRule Gets or sets a value that determines how the intersecting areas contained in this PathGeometry are combined.
Public propertyHasAnimatedPropertiesGets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties. (Inherited from Animatable.)
Public propertyIsFrozenGets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)
Public propertyIsSealedGets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
Public propertyTransformGets or sets the Transform object applied to a Geometry. (Inherited from Geometry.)
Top

  NameDescription
Public methodAddGeometry Converts the specified Geometry into a collection of PathFigure objects and adds it to the path. Note: If the specified Geometry is animated, the conversion from Geometry to PathFigure may result in some loss of information.
Public methodApplyAnimationClock(DependencyProperty, AnimationClock)Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.)
Public methodApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)
Public methodBeginAnimation(DependencyProperty, AnimationTimeline)Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.)
Public methodBeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)
Public methodCheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public methodClear Removes all PathFigure objects from this PathGeometry.
Public methodClearValue(DependencyProperty)Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
Public methodClearValue(DependencyPropertyKey)Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
Public methodCloneCreates a modifiable clone of this PathGeometry, making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values.
Public methodCloneCurrentValueCreates a modifiable clone of this PathGeometry object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are.
Public methodCoerceValueCoerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject.)
Public methodStatic memberCreateFromGeometryCreates a PathGeometry version of the specified Geometry.
Public methodEqualsDetermines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
Public methodFillContains(Geometry)Indicates whether the current geometry completely contains the specified Geometry. (Inherited from Geometry.)
Public methodFillContains(Point)Indicates whether the geometry contains the specified Point. (Inherited from Geometry.)
Public methodFillContains(Geometry, Double, ToleranceType)Indicates whether the current geometry contains the specified Geometry, given the specified margin of error. (Inherited from Geometry.)
Public methodFillContains(Point, Double, ToleranceType)Indicates whether the geometry contains the specified Point, given the specified margin of error. (Inherited from Geometry.)
Public methodFillContainsWithDetail(Geometry)Returns a value that describes the intersection between the current geometry and the specified geometry. (Inherited from Geometry.)
Public methodFillContainsWithDetail(Geometry, Double, ToleranceType)Returns a value that describes the intersection between the current geometry and the specified geometry, given the specified margin of error. (Inherited from Geometry.)
Public methodFreeze()Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
Public methodGetAnimationBaseValueReturns the non-animated value of the specified DependencyProperty. (Inherited from Animatable.)
Public methodGetArea()Gets the area of the filled region of the Geometry object. (Inherited from Geometry.)
Public methodGetArea(Double, ToleranceType)Gets the area, within the specified tolerance, of the filled region of the Geometry object. (Inherited from Geometry.)
Public methodGetAsFrozenCreates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
Public methodGetCurrentValueAsFrozenCreates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
Public methodGetFlattenedPathGeometry()Gets a PathGeometry that is a polygonal approximation of the Geometry object. (Inherited from Geometry.)
Public methodGetFlattenedPathGeometry(Double, ToleranceType)Gets a PathGeometry, within the specified tolerance, that is a polygonal approximation of the Geometry object. (Inherited from Geometry.)
Public methodGetHashCodeGets a hash code for this DependencyObject. (Inherited from DependencyObject.)
Public methodGetLocalValueEnumeratorCreates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
Public methodGetOutlinedPathGeometry()Gets a PathGeometry that is a simplified outline of the filled region of the Geometry. (Inherited from Geometry.)
Public methodGetOutlinedPathGeometry(Double, ToleranceType)Gets a PathGeometry, within the specified tolerance, that is a simplified outline of the filled region of the Geometry. (Inherited from Geometry.)
Public methodGetPointAtFractionLength Gets the Point and a tangent vector on this PathGeometry at the specified fraction of its length.
Public methodGetRenderBounds(Pen)Returns an axis-aligned rectangle that is exactly large enough to contain the geometry after it has been outlined with the specified Pen. (Inherited from Geometry.)
Public methodGetRenderBounds(Pen, Double, ToleranceType)Returns an axis-aligned rectangle that is exactly large enough to contain the geometry after it has been outlined with the specified Pen, given the specified tolerance factor. (Inherited from Geometry.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
Public methodGetWidenedPathGeometry(Pen)Gets a PathGeometry that is the shape defined by the stroke on the Geometry produced by the specified Pen. (Inherited from Geometry.)
Public methodGetWidenedPathGeometry(Pen, Double, ToleranceType)Gets a PathGeometry that is the shape defined by the stroke on the Geometry produced by the specified Pen, given the specified tolerance factor. (Inherited from Geometry.)
Public methodInvalidatePropertyRe-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
Public methodIsEmpty Determines whether this PathGeometry object is empty. (Overrides Geometry.IsEmpty().)
Public methodMayHaveCurves Determines whether this PathGeometry object may have curved segments. (Overrides Geometry.MayHaveCurves().)
Public methodReadLocalValueReturns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
Public methodSetCurrentValueSets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
Public methodSetValue(DependencyProperty, Object)Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
Public methodSetValue(DependencyPropertyKey, Object)Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
Protected methodShouldSerializePropertyReturns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
Public methodShouldSerializeTransformGets a value that indicates whether the value of the Transform property should be serialized. (Inherited from Geometry.)
Public methodStrokeContains(Pen, Point)Determines whether the specified Point is contained in the stroke produced by applying the specified Pen to the geometry. (Inherited from Geometry.)
Public methodStrokeContains(Pen, Point, Double, ToleranceType)Determines whether the specified Point is contained in the stroke produced by applying the specified Pen to the geometry, given the specified margin of error. (Inherited from Geometry.)
Public methodStrokeContainsWithDetail(Pen, Geometry)Returns a value that describes the intersection between the specified Geometry and the stroke created by applying the specified Pen to the current geometry. (Inherited from Geometry.)
Public methodStrokeContainsWithDetail(Pen, Geometry, Double, ToleranceType)Gets a value that describes the intersection between the specified Geometry and the stroke created by applying the specified Pen to the current geometry, given the specified margin of error. (Inherited from Geometry.)
Public methodToString()Creates a string representation of the object based on the current culture. (Inherited from Geometry.)
Public methodToString(IFormatProvider)Creates a string representation of the object using the specified culture-specific formatting information. (Inherited from Geometry.)
Public methodVerifyAccessEnforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Top

  NameDescription
Public eventChangedOccurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)
Top

  NameDescription
Public fieldStatic memberFiguresProperty Identifies the Figures dependency property.
Public fieldStatic memberFillRuleProperty Identifies the FillRule dependency property.
Top

  NameDescription
Explicit interface implemetationPrivate methodIFormattable.ToStringFormats the value of the current instance using the specified format. (Inherited from Geometry.)
Top

Each PathGeometry object defines a collection of PathFigure objects. Each of the PathFigure objects is composed of one or more PathSegment objects, such as ArcSegment and LineSegment, which actually define their shape.

The filled area of the PathGeometry is defined by taking all of the contained PathFigure objects that have their IsFilled property set to true and applying the FillRule to determine the enclosed area.

This example shows how to create a line segment. To create a line segment, use the PathGeometry, PathFigure, and LineSegment classes.

The following examples draw a LineSegment from (10, 50) to (200, 70). The following illustration shows the resulting LineSegment; a grid background was added to show the coordinate system.

A LineSegment drawn from (10,50) to (200,700)

A LineSegment in a PathFigure

[xaml]

In Extensible Application Markup Language (XAML), you may use attribute syntax to describe a path.

<Path Stroke="Black" StrokeThickness="1"  
  Data="M 10,50 L 200,70" />

[xaml]

(Note that this attribute syntax actually creates a StreamGeometry, a lighter-weight version of a PathGeometry. For more information, see the Path Markup Syntax page.)

In XAML, you may also draw a line segment by using object element syntax. The following is equivalent to the previous XAML example.

PathFigure myPathFigure = new PathFigure();
myPathFigure.StartPoint = new Point(10, 50);

LineSegment myLineSegment = new LineSegment();
myLineSegment.Point = new Point(200, 70);

PathSegmentCollection myPathSegmentCollection = new PathSegmentCollection();
myPathSegmentCollection.Add(myLineSegment);

myPathFigure.Segments = myPathSegmentCollection;

PathFigureCollection myPathFigureCollection = new PathFigureCollection();
myPathFigureCollection.Add(myPathFigure);

PathGeometry myPathGeometry = new PathGeometry();
myPathGeometry.Figures = myPathFigureCollection;

Path myPath = new Path();
myPath.Stroke = Brushes.Black;
myPath.StrokeThickness = 1;
myPath.Data = myPathGeometry;
<Path Stroke="Black" StrokeThickness="1">
  <Path.Data>
    <PathGeometry>
      <PathFigure StartPoint="10,50">
        <LineSegment Point="200,70" />
      </PathFigure>
    </PathGeometry>
  </Path.Data>
</Path>

This example is part of larger sample; for the complete sample, see the Geometries Sample.

More Code

How to: Create an Elliptical ArcThis example shows how to draw an elliptical arc. To create an elliptical arc, use the PathGeometry, PathFigure, and ArcSegment classes.
How to: Create a Cubic Bezier CurveThis example shows how to create a cubic Bezier curve. To create a cubic Bezier curve, use the PathGeometry, PathFigure, and BezierSegment classes. To display the resulting geometry, use a Path element, or use it with a GeometryDrawing or a DrawingContext. In the following examples, a cubic Bezier curve is drawn from (10, 100) to (300, 100). The curve has control points of (100, 0) and (200, 200).
How to: Create a Quadratic Bezier Curve This example shows how to create a quadratic Bezier curve. To create a quadratic Bezier curve, use the PathGeometry, PathFigure, and QuadraticBezierSegment classes.
How to: Create a Composite Shape This example shows how to create composite shapes using Geometry objects and display them using a Path element. In the following example, a LineGeometry, EllipseGeometry, and a RectangleGeometry are used with a GeometryGroup to create a composite shape. The geometries are then drawn using a Path element.
How to: Create Multiple Subpaths Within a PathGeometryThis example shows how to create multiple subpaths in a PathGeometry. To create multiple subpaths, you create a PathFigure for each subpath.
How to: Control the Fill of a Composite ShapeThe FillRule property of a GeometryGroup or a PathGeometry, specifies a "rule" which the composite shape uses to determine whether a given point is part of the geometry. There are two possible values for FillRule: EvenOdd and Nonzero. The following sections will describe how to use these two rules.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft