Path Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Draws a series of connected lines and curves. The line and curve dimensions are declared through the Data property, and can be specified either with a Path-specific mini-language, or with an object model.

Inheritance Hierarchy

System..::.Object
System.Windows..::.DependencyObject
System.Windows..::.UIElement
System.Windows..::.FrameworkElement
System.Windows.Shapes..::.Shape
System.Windows.Shapes..::.Path

Namespace: System.Windows.Shapes
Assembly: System.Windows (in System.Windows.dll)
XMLNS for XAML: Not mapped to an xmlns.

Syntax

Public Class Path _
    Inherits Shape
public class Path : Shape
<Path .../>

The Path type exposes the following members.

Constructors

Name Description
Path Initializes a new instance of the Path class.

Top

Properties

Name Description
ActualHeight Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.)
ActualWidth Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.)
AllowDrop Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations. (Inherited from UIElement.)
CacheMode Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
Clip Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
Cursor Infrastructure. Gets or sets the cursor image that displays while the pointer is over a FrameworkElement. (Inherited from FrameworkElement.)
Data Gets or sets a Geometry that specifies the shape to be drawn.
DataContext Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.)
DesiredSize Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.)
Dispatcher Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Fill Gets or sets the Brush that specifies how to paint the interior of the shape. (Inherited from Shape.)
FlowDirection Gets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.)
GeometryTransform Gets a value that represents a Transform that is applied to the geometry of a Shape prior to when it is drawn. (Inherited from Shape.)
Height Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.)
HorizontalAlignment Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control. (Inherited from FrameworkElement.)
IsHitTestVisible Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.)
Language Gets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.)
Margin Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.)
MaxHeight Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
MaxWidth Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
MinHeight Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
MinWidth Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Name Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name. (Inherited from FrameworkElement.)
Opacity Gets or sets the degree of the object's opacity. (Inherited from UIElement.)
OpacityMask Gets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.)
Parent Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.)
Projection Gets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.)
RenderSize Gets the final render size of a UIElement. (Inherited from UIElement.)
RenderTransform Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.)
RenderTransformOrigin Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement.)
Resources Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax. (Inherited from FrameworkElement.)
Stretch Gets or sets a Stretch enumeration value that describes how the shape fills its allocated space. (Inherited from Shape.)
Stroke Gets or sets the Brush that specifies how the Shape outline is painted. (Inherited from Shape.)
StrokeDashArray Gets or sets a collection of Double values that indicate the pattern of dashes and gaps that is used to outline shapes. (Inherited from Shape.)
StrokeDashCap Gets or sets a PenLineCap enumeration value that specifies how the ends of a dash are drawn. (Inherited from Shape.)
StrokeDashOffset Gets or sets a Double that specifies the distance within the dash pattern where a dash begins. (Inherited from Shape.)
StrokeEndLineCap Gets or sets a PenLineCap enumeration value that describes the Shape at the end of a line. (Inherited from Shape.)
StrokeLineJoin Gets or sets a PenLineJoin enumeration value that specifies the type of join that is used at the vertices of a Shape. (Inherited from Shape.)
StrokeMiterLimit Gets or sets a limit on the ratio of the miter length to half the StrokeThickness of a Shape element. (Inherited from Shape.)
StrokeStartLineCap Gets or sets a PenLineCap enumeration value that describes the Shape at the start of a Stroke. (Inherited from Shape.)
StrokeThickness Gets or sets the width of the Shape stroke outline. (Inherited from Shape.)
Style Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
Tag Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.)
Triggers Gets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.)
UseLayoutRounding Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels. (Inherited from UIElement.)
UseOptimizedManipulationRouting Gets or sets a value that indicates whether the system should handle input events or whether the FrameworkElement should handle input events. (Inherited from FrameworkElement.)
VerticalAlignment Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control. (Inherited from FrameworkElement.)
Visibility Gets or sets the visibility of a UIElement. A UIElement that is not visible does not render and does not communicate its desired size to layout. (Inherited from UIElement.)
Width Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.)

Top

Methods

Name Description
AddHandler Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked for routed event that had already been marked as handled by another element along the event route. (Inherited from UIElement.)
Arrange Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update. (Inherited from UIElement.)
ArrangeOverride Provides the behavior for the Arrange pass of Windows Phone layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement.)
CaptureMouse Sets touch capture to a UIElement. (Inherited from UIElement.)
CheckAccess Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject.)
Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
FindName Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement.)
GetAnimationBaseValue Returns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
GetBindingExpression Retrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.)
GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
GetType Gets the Type of the current instance. (Inherited from Object.)
GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
InvalidateArrange Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement.)
InvalidateMeasure Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.)
Measure Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update. (Inherited from UIElement.)
MeasureOverride Provides the behavior for the Measure pass of Windows Phone layout. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement.)
MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
OnApplyTemplate When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in an application. For more information, see Remarks. (Inherited from FrameworkElement.)
OnCreateAutomationPeer When implemented in a derived class, returns class-specific AutomationPeer implementations for the Windows Phone automation infrastructure. (Inherited from UIElement.)
ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
ReleaseMouseCapture Removes touch capture from a UIElement. After this call, typically no object holds touch capture. (Inherited from UIElement.)
RemoveHandler Removes the specified routed event handler from this UIElement. (Inherited from UIElement.)
SetBinding Attaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.)
SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
ToString Returns a string that represents the current object. (Inherited from Object.)
TransformToVisual Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.)
UpdateLayout Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.)

Top

Events

Name Description
BindingValidationError Occurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.)
DoubleTap Occurs when a DoubleTap gesture is committed while over this UIElement. (Inherited from UIElement.)
GotFocus Occurs when a UIElement receives focus. (Inherited from UIElement.)
Hold Occurs when a Hold gesture is committed while over this UIElement. (Inherited from UIElement.)
KeyDown Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.)
KeyUp Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.)
LayoutUpdated Occurs when the layout of the Windows Phone visual tree changes. (Inherited from FrameworkElement.)
Loaded Occurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.)
LostFocus Occurs when a UIElement loses focus. (Inherited from UIElement.)
LostMouseCapture Occurs when the UIElement loses touch capture. (Inherited from UIElement.)
ManipulationCompleted Occurs when a manipulation and inertia on the UIElement is complete. (Inherited from UIElement.)
ManipulationDelta Occurs when the input device changes position during a manipulation. (Inherited from UIElement.)
ManipulationStarted Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement.)
MouseEnter Occurs when a screen tap occurs within the bounding area of a UIElement. (Inherited from UIElement.)
MouseLeave Occurs when a touch event occurs outside the bounding area of a UIElement. (Inherited from UIElement.)
MouseLeftButtonDown Occurs when a UIElement is tapped. (Inherited from UIElement.)
MouseLeftButtonUp Occurs when the finger is lifted off of a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.)
MouseMove Occurs when the coordinate position of the finger on the screen while touching a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.)
MouseWheel Infrastructure. Occurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.)
SizeChanged Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.)
Tap Occurs when a Tap gesture is committed while over this UIElement. (Inherited from UIElement.)
TextInput Occurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.)
TextInputStart Occurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.)
TextInputUpdate Occurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.)
Unloaded Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.)

Top

Fields

Name Description
DataProperty Identifies the Data dependency property.

Top

Remarks

Fundamentally, a Path is a Shape. But the Path can be used to create much more complex two-dimensional graphics than the other Shapes are capable of. The Path object can draw closed or open shapes, lines, and curves. For a description of the shapes that the Path element supports, see the Data property.

A Path supports two parallel techniques for declaring its contents: as an object model using discrete geometries declared in markup or code, or as a mini-language declared in markup. The geometry object model can use the GeometryGroup as data in order to specify a composite of multiple geometries. The mini-language is analogous to a pathing language output used in some graphics tools.

Note

Performance Note: For best performance, avoid explicitly setting the Width and Height of a Path. Setting the Width and Height results in additional stretching, which has a performance cost. Instead, rely on the explicitly set coordinates of the Path and its contained data to control its shape and position. In effect, the Path will have a natural height/width, although those values are not reported to the object model. For more information, see Stretch.

Deriving From Path

By deriving from Path, you can create custom shapes. Deriving from Shape directly is not useful, because the class does not have any virtuals or other extensible mechanisms for defining its visuals. But Path has Data. By specifying a value for Data you can supply the necessary visuals for any custom shape that can be described by a geometry, or even by the Path..::.Data "mini-language".

Existing shapes in XAML all have properties for Width and Height, because shapes derive from FrameworkElement. Some shapes, for example Ellipse, use Width and Height to basically declare their dimensions and modify the internally generated visual shape. Other shapes, particularly Path, use properties other than Width and Height to declare specifics of the visual, although Width and Height could still be set and might result in an effective scale transform. When you derive from Path you could choose to go with either model:

  • Use initialization logic to generate the necessary geometry for your custom shape, which you then set as the Path..::.Data. Width and Height are used as information for this initial geometry. Also make sure to run that same logic in an ArrangeOverride implementation on the custom shape, to account for run time changes to Width and Height

  • Use initialization logic to generate the necessary geometry based on your own class-specific properties that influence the custom shape. Account for changes both to these custom properties and to Width and Height as part of an ArrangeOverride implementation.

  • Note that a custom shape derived from Path would still have an open, settable Path..::.Data. You could either warn against setting that value directly in your custom class, or could potentially shadow Path..::.Data and give it a no-op behavior.

Examples

The following example uses a Path to draw an ellipse.

An EllipseGeometry drawn at (50,50)

<Canvas> 

  <Path Fill="Gold" Stroke="Black" StrokeThickness="1">
    <Path.Data>
      <EllipseGeometry Center="50,50" RadiusX="50" RadiusY="50" />
    </Path.Data>
  </Path> 
</Canvas>

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

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.

See Also

Reference

System.Windows.Shapes Namespace

Data