PropertyPath.PathParameters Property


Gets the list of parameters to use when the path refers to indexed parameters.

Namespace:   System.Windows
Assembly:  PresentationFramework (in PresentationFramework.dll)

Public ReadOnly Property PathParameters As Collection(Of Object)

Property Value

Type: System.Collections.ObjectModel.Collection(Of Object)

The parameter list.

The properties for a PropertyPath are typically established through the constructors. For setting PathParameters, the PropertyPath constructor is particularly convenient because the pathParameters constructor argument is designated as params, meaning that you do not need to create or dimension an array for construction. You simply specify each member of the array as an additional parameter.

If the final property that is the target is a Freezable type, that value will be cloned. For details, see Storyboards Overview.

The actual evaluation of the property chain is performed by the storyboard animation mechanisms. At the PropertyPath level, no validation is performed to make sure that the steps of the path connect at all. For instance, you can construct a property path that has Control.BackgroundProperty as the first step, and FrameworkElement.FlowDirectionProperty as the second step. But such a property path would fail if actually applied as a target, because the Brush type that fills Control.BackgroundProperty does not have a FrameworkElement.FlowDirection property. Invalid property paths fail silently. For more information, see Storyboards Overview.

XAML: When you use a PropertyPath to describe a property reference in XAML, as an attribute value, the string that you specify is first handled by a type converter (PropertyPathConverter). This type converter then processes the string and based on its syntax will call one of the PropertyPath constructor signatures. This indirection through the type converter handling an attribute value is generally how you use PropertyPath in XAML, rather than declaring a PropertyPath object element and then applying specific values to attributes such as Path and PathParameters. For more information, see PropertyPath XAML Syntax.

Members of the PropertyPath type are not typically set in a direct XAML syntax. See Remarks.

.NET Framework
Available since 3.0
Return to top