PropertyPath Class

Reference

Definition

Namespace:: System.Windows

Assembly:: PresentationFramework.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.

public ref class PropertyPath sealed

[System.ComponentModel.TypeConverter(typeof(System.Windows.PropertyPathConverter))]
public sealed class PropertyPath

[<System.ComponentModel.TypeConverter(typeof(System.Windows.PropertyPathConverter))>]
type PropertyPath = class

Public NotInheritable Class PropertyPath

Inheritance: Object
PropertyPath

Attributes: TypeConverterAttribute

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.

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.

Constructors

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

Properties

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.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (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)

Applies to

Dela via