HierarchicalDataTemplate Class (System.Windows)

Switch View

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

HierarchicalDataTemplate Class

Updated: July 2008

Represents a DataTemplate that supports HeaderedItemsControl, such as TreeViewItem or MenuItem.

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 (Declaration)

Public Class HierarchicalDataTemplate _
    Inherits DataTemplate

Visual Basic (Usage)

Dim instance As HierarchicalDataTemplate

public class HierarchicalDataTemplate : DataTemplate

Visual C++

public ref class HierarchicalDataTemplate : public DataTemplate

JScript

public class HierarchicalDataTemplate extends DataTemplate

XAML Object Element Usage

<HierarchicalDataTemplate>
  VisualTree
</HierarchicalDataTemplate>

Examples

In the following example, ListLeagueList is a list of League objects. Each League object has a Name and a collection of Division objects. Each Division has a Name and a collection of Team objects, and each Team object has a Name.

XAML

<Window x:Class="SDKSample.Window1"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  Title="HierarchicalDataTemplate Sample"
  xmlns:src="clr-namespace:SDKSample">
  <DockPanel>
    <DockPanel.Resources>
      <src:ListLeagueList x:Key="MyList"/>

      <HierarchicalDataTemplate DataType    = "{x:Type src:League}"
                                ItemsSource = "{Binding Path=Divisions}">
        <TextBlock Text="{Binding Path=Name}"/>
      </HierarchicalDataTemplate>

      <HierarchicalDataTemplate DataType    = "{x:Type src:Division}"
                                ItemsSource = "{Binding Path=Teams}">
        <TextBlock Text="{Binding Path=Name}"/>
      </HierarchicalDataTemplate>

      <DataTemplate DataType="{x:Type src:Team}">
        <TextBlock Text="{Binding Path=Name}"/>
      </DataTemplate>
    </DockPanel.Resources>

    <Menu Name="menu1" DockPanel.Dock="Top" Margin="10,10,10,10">
        <MenuItem Header="My Soccer Leagues"
                  ItemsSource="{Binding Source={StaticResource MyList}}" />
    </Menu>

    <TreeView>
      <TreeViewItem ItemsSource="{Binding Source={StaticResource MyList}}" Header="My Soccer Leagues" />
    </TreeView>

  </DockPanel>
</Window>

The example shows that with the use of HierarchicalDataTemplate, you can easily display list data that contains other lists. The following is a screenshot of the example.

HierarchicalDataTemplate sample screen shot

For the complete sample, see Displaying Hierarchical Data Sample.

More Code

How to: Create Simple or Complex TreeViews	This example shows how to create simple or complex TreeView controls.
How to: Use SelectedValue, SelectedValuePath, and SelectedItem	This example shows how to use the SelectedValue and SelectedValuePath properties to specify a value for the SelectedItem of a TreeView.

Inheritance Hierarchy

System..::.Object
  System.Windows.Threading..::.DispatcherObject
    System.Windows..::.FrameworkTemplate
      System.Windows..::.DataTemplate
        System.Windows..::.HierarchicalDataTemplate

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.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0

Reference

HierarchicalDataTemplate Members

System.Windows Namespace

Other Resources

Data Templating Overview

TreeView Overview

Menu Overview

Change History

Date	History	Reason
July 2008	Added new members: AlternationCount property, ItemBindingGroup property, ItemContainerStyle property, ItemContainerStyleSelector property, ItemStringFormat property.	SP1 feature change.

Date

History

Reason

July 2008

Added new members: AlternationCount property, ItemBindingGroup property, ItemContainerStyle property, ItemContainerStyleSelector property, ItemStringFormat property.

SP1 feature change.