TreeView.SelectedValuePath Property

Reference

Definition

Namespace:: System.Windows.Controls

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.

Gets or sets the path that is used to get the SelectedValue of the SelectedItem in a TreeView.

public:
 property System::String ^ SelectedValuePath { System::String ^ get(); void set(System::String ^ value); };

[System.ComponentModel.Bindable(true)]
public string SelectedValuePath { get; set; }

[<System.ComponentModel.Bindable(true)>]
member this.SelectedValuePath : string with get, set

Public Property SelectedValuePath As String

Property Value

String

A string that contains the path that is used to get the SelectedValue. The default value is String.Empty.

Attributes: BindableAttribute

Examples

The following example shows a TreeView that uses a HierarchicalDataTemplate to display the EmployeeName and EmployeeWorkDay properties of an Employee and sets the SelectedValue property to the EmployeeNumber. When you select an EmployeeName in the TreeView, the SelectedValue is set to the EmployeeNumber.

<TreeView ItemsSource="{Binding Source={StaticResource myEmployeeData},
    XPath=EmployeeInfo}" 
    Name="myTreeView" 
    SelectedValuePath="EmployeeNumber" 
    />

<TextBlock Margin="10">SelectedValuePath: </TextBlock>
<TextBlock Margin="10,0,0,0" 
           Text="{Binding ElementName=myTreeView, 
                          Path=SelectedValuePath}"
           Foreground="Blue"/>

<TextBlock Margin="10">SelectedValue: </TextBlock>
<TextBlock Margin="10,0,0,0" 
           Text="{Binding ElementName=myTreeView, 
                          Path=SelectedValue}"
           Foreground="Blue"/>

Remarks

The SelectedValuePath property specifies the path to the property that is used to determine the value of the SelectedValue property. For example, assume that a TreeView is bound to a collection of objects of type Employee, which has two properties called EmployeeName and EmployeeNumber. You can use a HierarchicalDataTemplate to display the value of EmployeeName in the TreeView and set SelectedValuePath to "EmployeeNumber" to have SelectedValue return the value of EmployeeNumber.

Dependency Property Information

Item	Value
Identifier field	SelectedValuePathProperty
Metadata properties set to `true`	None

Applies to

Jaa