Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

PropertyPath class

Applies to Windows and Windows Phone

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.

Inheritance

Object
  DependencyObject
    PropertyPath

Syntax


Public NotInheritable Class PropertyPath
    Inherits DependencyObject

Attributes

[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06020000)]
[WebHostHidden()]

Members

The PropertyPath class has these types of members:

Constructors

The PropertyPath class has these constructors.

ConstructorDescription
PropertyPath Initializes a new instance of the PropertyPath class based on a path string.

 

Methods

The PropertyPath class has these methods. It also inherits methods from the Object class.

MethodDescription
ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject)
GetAnimationBaseValue Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)

 

Properties

The PropertyPath class has these properties.

PropertyAccess typeDescription

Dispatcher

Read-onlyGets the CoreDispatcher that this object is associated with. (Inherited from DependencyObject)

Path

Read-onlyGets the path value held by this PropertyPath.

 

Remarks

The main reason you might work with a PropertyPath object is to clone existing binding properties and use them somewhere else:

  • Get the Path from an existing binding (Binding.Path).
  • Use that string value to construct a new PropertyPath.
  • Create a new Binding. Use the new PropertyPath for its Binding.Path (and probably adjust some other properties too).
  • Apply the new Binding to a different object-property combination, using SetBinding.

Animation targeting also uses a property path concept, as documented in the Property-path syntax topic. However, animation targeting doesn't use PropertyPath as the underlying type, it expresses the paths as strings and uses strings for all related API calls.

Requirements

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml
Windows::UI::Xaml [C++]

Metadata

Windows.winmd

See also

DependencyObject
Property-path syntax
Binding markup extension

 

 

Show:
© 2014 Microsoft