Skip to main content
.NET Framework Class Library
PathFigure Class

Represents a subsection of a geometry, a single connected series of two-dimensional geometric segments.

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
Syntax
<[%$TOPIC/ms635261_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/ms635261_en-us_VS_110_2_0_0_0_1%].None, Readability := [%$TOPIC/ms635261_en-us_VS_110_2_0_0_0_2%].Unreadable)> _
<[%$TOPIC/ms635261_en-us_VS_110_2_0_0_0_3%]("Segments")> _
Public NotInheritable Class PathFigure _
	Inherits [%$TOPIC/ms635261_en-us_VS_110_2_0_0_0_4%] _
	Implements [%$TOPIC/ms635261_en-us_VS_110_2_0_0_0_5%]
[[%$TOPIC/ms635261_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/ms635261_en-us_VS_110_2_0_1_0_1%].None, Readability = [%$TOPIC/ms635261_en-us_VS_110_2_0_1_0_2%].Unreadable)]
[[%$TOPIC/ms635261_en-us_VS_110_2_0_1_0_3%]("Segments")]
public sealed class PathFigure : [%$TOPIC/ms635261_en-us_VS_110_2_0_1_0_4%], 
	[%$TOPIC/ms635261_en-us_VS_110_2_0_1_0_5%]
[[%$TOPIC/ms635261_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/ms635261_en-us_VS_110_2_0_2_0_1%]::None, Readability = [%$TOPIC/ms635261_en-us_VS_110_2_0_2_0_2%]::Unreadable)]
[[%$TOPIC/ms635261_en-us_VS_110_2_0_2_0_3%](L"Segments")]
public ref class PathFigure sealed : public [%$TOPIC/ms635261_en-us_VS_110_2_0_2_0_4%], 
	[%$TOPIC/ms635261_en-us_VS_110_2_0_2_0_5%]
[<[%$TOPIC/ms635261_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/ms635261_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/ms635261_en-us_VS_110_2_0_3_0_2%].None, Readability = [%$TOPIC/ms635261_en-us_VS_110_2_0_3_0_3%].Unreadable)>]
[<[%$TOPIC/ms635261_en-us_VS_110_2_0_3_0_4%]("Segments")>]
type PathFigure =  
    class 
        inherit [%$TOPIC/ms635261_en-us_VS_110_2_0_3_0_5%] 
        interface [%$TOPIC/ms635261_en-us_VS_110_2_0_3_0_6%] 
    end
<PathFigure .../>
-or-
<PathFigure ...>
  oneOrMoreSegments
</PathFigure>

XAML Values

oneOrMoreSegments

One or more object elements for objects that derive from PathSegment. Typically these are: ArcSegment,

BezierSegment, LineSegment, PolyBezierSegment, PolyLineSegment, PolyQuadraticBezierSegment, QuadraticBezierSegment.

The PathFigure type exposes the following members.

Constructors
  NameDescription
Public method PathFigureInitializes a new instance of the PathFigure class.
Public method PathFigure(Point, IEnumerablePathSegment, Boolean)Initializes a new instance of the PathFigure class with the specified StartPoint, Segments, and IsClosed values.
Top
Properties
  NameDescription
Public property CanFreezeGets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)
Public property DependencyObjectTypeGets the DependencyObjectType that wraps the CLR type of this instance.  (Inherited from DependencyObject.)
Public property DispatcherGets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public property HasAnimatedPropertiesGets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties. (Inherited from Animatable.)
Public property IsClosedGets or sets a value that specifies whether this figures first and last segments are connected.
Public property IsFilledGets or sets whether the contained area of this PathFigure is to be used for hit-testing, rendering, and clipping.
Public property IsFrozenGets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)
Public property IsSealedGets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
Public property SegmentsGets or sets the collection of segments that define the shape of this PathFigure object.
Public property StartPointGets or sets the Point where the PathFigure begins.
Top
Methods
  NameDescription
Public method ApplyAnimationClock(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 method ApplyAnimationClock(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 method BeginAnimation(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 method BeginAnimation(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 method CheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public method ClearValue(DependencyProperty)Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
Public method ClearValue(DependencyPropertyKey)Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
Public method CloneCreates a modifiable clone of this PathFigure, 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 method CloneCurrentValueCreates a modifiable clone of this PathFigure 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 method CoerceValueCoerces 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 method EqualsDetermines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
Public method FreezeMakes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
Public method GetAnimationBaseValueReturns the non-animated value of the specified DependencyProperty. (Inherited from Animatable.)
Public method GetAsFrozenCreates 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 method GetCurrentValueAsFrozenCreates 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 method GetFlattenedPathFigureGets a PathFigure object that is an polygonal approximation of this PathFigure object.
Public method GetFlattenedPathFigure(Double, ToleranceType) Gets a PathFigure object, within the specified error of tolerance, that is an polygonal approximation of this PathFigure object.
Public method GetHashCodeGets a hash code for this DependencyObject. (Inherited from DependencyObject.)
Public method GetLocalValueEnumeratorCreates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method GetValueReturns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
Public method InvalidatePropertyRe-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
Public method MayHaveCurvesDetermines whether this PathFigure object may have curved segments.
Public method ReadLocalValueReturns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
Public method SetCurrentValueSets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
Public method SetValue(DependencyProperty, Object)Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
Public method SetValue(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 method ShouldSerializePropertyReturns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
Public method ToStringCreates a string representation of this object. (Overrides ObjectToString.)
Public method ToString(IFormatProvider)Creates a string representation of this object using the specified culture-specific formatting.
Public method VerifyAccessEnforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Top
Events
  NameDescription
Public event ChangedOccurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)
Top
Fields
  NameDescription
Public field Static member IsClosedPropertyIdentifies the IsClosed dependency property.
Public field Static member IsFilledPropertyIdentifies the IsFilled dependency property.
Public field Static member SegmentsProperty Identifies the Segments dependency property.
Public field Static member StartPointPropertyThe identifier for the StartPoint dependency property.
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method IFormattableToStringInfrastructure.  Formats the value of the current instance using the specified format.
Top
Remarks

A PathGeometry is made up of one or more figures, represented by the PathFigure class. Each figure is itself made up of one or more segments, defined by the PathSegment class.

Examples

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.

			Dim myPathFigure As New PathFigure()
			myPathFigure.StartPoint = New Point(10, 50)

			Dim myLineSegment As New LineSegment()
			myLineSegment.Point = New Point(200, 70)

			Dim myPathSegmentCollection As New PathSegmentCollection()
			myPathSegmentCollection.Add(myLineSegment)

			myPathFigure.Segments = myPathSegmentCollection

			Dim myPathFigureCollection As New PathFigureCollection()
			myPathFigureCollection.Add(myPathFigure)

			Dim myPathGeometry As New PathGeometry()
			myPathGeometry.Figures = myPathFigureCollection

			Dim myPath As New Path()
			myPath.Stroke = Brushes.Black
			myPath.StrokeThickness = 1
			myPath.Data = myPathGeometry
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 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.
Version Information

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

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.

Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.