PropertyPath Class (System.Windows)

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 11/.NET Framework 4.5

Other versions are also available for the following:

.NET Framework Class Library

PropertyPath Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Implements a data structure for describing a property as a path below another property, or below an owning type. Property paths are used in data binding to objects, and in storyboards and timelines for animations.

Inheritance Hierarchy

System..::.Object
System.Windows..::.PropertyPath

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

Syntax

Visual Basic

<TypeConverterAttribute(GetType(PropertyPathConverter))> _
Public NotInheritable Class PropertyPath

[TypeConverterAttribute(typeof(PropertyPathConverter))]
public sealed class PropertyPath

Visual C++

[TypeConverterAttribute(typeof(PropertyPathConverter))]
public ref class PropertyPath sealed

[<Sealed>]
[<TypeConverterAttribute(typeof(PropertyPathConverter))>]
type PropertyPath =  class end

XAML Attribute Usage

<object property="propertyPath" .../>

XAML Values

propertyPath: A string that is evaluated to be either a simple or complex property path. The syntax for setting a PropertyPath in XAML is versatile but complex, and is described in the separate topic PropertyPath XAML Syntax.

The PropertyPath type exposes the following members.

Constructors

	Name	Description
	PropertyPath(Object)	Initializes a new instance of the PropertyPath class.
	PropertyPath(String, array<Object>[]()[])	Initializes a new instance of the PropertyPath class, with the provided pathing token string and parameters.

Top

Properties

	Name	Description
	Path	Gets or sets the string that describes the path.
	PathParameters	Gets the list of parameters to use when the path refers to indexed parameters.

Top

Methods

	Name	Description
	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 it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

This class contains a string Path, and list of dependency properties that are the PathParameters into the string Path.

PropertyPath supports two modes of behavior:

Source mode describes a path to a property that is used as a source for some other operation. This mode is used by the Binding class to support data binding.

Target mode describes a path to a property that will be set as a target property. This mode is used by animation in support of storyboard and timeline setters.

For instance, Background.Opacity is a two-step path. This path implies: first, find the Background property of an object, get the value object that the Background property is set to, and then get the value of the Opacity property on that object.

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 8 Release Preview, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 SP2, 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.

Reference

System.Windows Namespace

Other Resources

Data Binding Overview

PropertyPath XAML Syntax

x:Static Markup Extension

Storyboards Overview

Styling and Templating

Dependency Properties Overview