详解Silverlight Treeview的HierarchicalDataTemplate使用

在Silverlight项目中，Treeview控件是比较常用的表示层次或者等级的控件，该控件可以非常清晰的显示数据之间的隶属关系。对于Treeview控件的基本使用已经有很多文章介绍，这里我想讲解一下Silverlight Treeivew的HierarchicalDataTemplate的使用方法。

HierarchicalDataTemplate可以叫做"层级式数据模板"，主要是应用层级比较明显数据集合。下面我来一步步演示HierarchicalDataTemplate在Silverlight treeview中的使用方法。在演示中，我将引用另外一个Silverlight控件ListBox进行对比，因为，Treeview和Listbox都属于Itemscontrol，

所以有很多类似相同之处，通过对比能够帮助大家记忆以及使用该控件。

首先建立一个空的项目，

在MainPage页面中建立一个ListBox，在Xaml中写入代码，

<UserControl x:Class="TreeviewDemo.MainPage"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
    xmlns:sys="clr-namespace:System;assembly=mscorlib"
    mc:Ignorable="d" d:DesignWidth="640" d:DesignHeight="480">
  <Grid x:Name="LayoutRoot">
        <ListBox>
            <sys:String>树型演示1</sys:String>
            <sys:String>树型演示2</sys:String>
            <sys:String>树型演示3</sys:String>
            <sys:String>树型演示4</sys:String>
            <sys:String>树型演示5</sys:String>
        </ListBox>
    </Grid>
</UserControl>

运行后会显示:

在上面代码基础上，我们可以添加一个ItemTemplate，对数据进行绑定。

<UserControl x:Class="TreeviewDemo.MainPage"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
    xmlns:sys="clr-namespace:System;assembly=mscorlib"
    mc:Ignorable="d" d:DesignWidth="640" d:DesignHeight="480">
  <Grid x:Name="LayoutRoot">
        <ListBox>
            <ListBox.ItemTemplate>
                <DataTemplate>
                    <TextBlock Foreground="Blue" Text="{Binding}" />
                </DataTemplate>
            </ListBox.ItemTemplate>
            <sys:String>树型演示1</sys:String>
            <sys:String>树型演示2</sys:String>
            <sys:String>树型演示3</sys:String>
            <sys:String>树型演示4</sys:String>
            <sys:String>树型演示5</sys:String>
        </ListBox>
    </Grid>
</UserControl>

运行结果如下：

这里ListBox的选项都变成了蓝色。

就像我们前面所说的，ListBox是一个ItemsControl，任何ItemsControl都是相同的，可以将它们的内容包括到一个容器中。所以，我们可以再次重写上面代码：

<UserControl x:Class="TreeviewDemo.MainPage"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
    xmlns:sys="clr-namespace:System;assembly=mscorlib"
    mc:Ignorable="d" d:DesignWidth="640" d:DesignHeight="480">
  <Grid x:Name="LayoutRoot">
        <ListBox>
            
            
            <ListBoxItem Content="树型演示1">
                <ListBoxItem.ContentTemplate>
                    <DataTemplate x:Name="myTemplate">
                        <TextBlock Foreground="Blue" Text="{Binding}" />
                    </DataTemplate>
                </ListBoxItem.ContentTemplate>
            </ListBoxItem>
            <ListBoxItem Content="树型演示2" ContentTemplate="{Binding ElementName=myTemplate}" />
            <ListBoxItem Content="树型演示3" ContentTemplate="{Binding ElementName=myTemplate}" />
            <ListBoxItem Content="树型演示4" ContentTemplate="{Binding ElementName=myTemplate}" />
            <ListBoxItem Content="树型演示5" ContentTemplate="{Binding ElementName=myTemplate}" />
        </ListBox>
    </Grid>
</UserControl>

在上面的代码中，ListBox中创建五个ListBoxItem，ListBoxItem的Content属性绑定着不同的选项，而ListBoxItem的ContentTemplate绑定着ListBox的ItemTemplate。

运行结果和上面的相同：

根据上面的基础，我们可以使用同样的概念来理解Silverlight Treeivew控件。在使用Treeview控件前，需要添加引用，Treeview控件被装配在System.Windows.Controls下，另外在客户端页面需要添加命名空间如下：

xmlns:Controls="clr-namespace:System.Windows.Controls;assembly=System.Windows.Controls"

Treeview控件也是一个ItemsControl，同样，每次初始化，Treeview控件会为所属选项创建TreeViewItem。如果我们使用和ListBox同样的代码，可以得到下面结果，

<UserControl x:Class="TreeviewDemo.MainPage"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
    xmlns:sys="clr-namespace:System;assembly=mscorlib"
    xmlns:Controls="clr-namespace:System.Windows.Controls;assembly=System.Windows.Controls" 
    mc:Ignorable="d" d:DesignWidth="640" d:DesignHeight="480">
  <Grid x:Name="LayoutRoot">
        <Controls:TreeView>
            <sys:String>树形演示1</sys:String>
            <sys:String>树形演示2</sys:String>
            <sys:String>树形演示3</sys:String>
        </Controls:TreeView>
    </Grid>
</UserControl>

运行结果：

同样，也可以添加ItemTemplate到Treeview控件，

<UserControl x:Class="TreeviewDemo.MainPage"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
    xmlns:sys="clr-namespace:System;assembly=mscorlib"
    xmlns:Controls="clr-namespace:System.Windows.Controls;assembly=System.Windows.Controls" 
    mc:Ignorable="d" d:DesignWidth="640" d:DesignHeight="480">
  <Grid x:Name="LayoutRoot">
        <Controls:TreeView>
            <Controls:TreeView.ItemTemplate>
                    <DataTemplate>
                        <TextBlock Foreground="Green" Text="{Binding}" />
                    </DataTemplate>
            </Controls:TreeView.ItemTemplate>
            <sys:String>树型演示1</sys:String>
            <sys:String>树型演示2</sys:String>
            <sys:String>树型演示3</sys:String>
        </Controls:TreeView>
    </Grid>
</UserControl>

运行结果:

从上面，我们可以看出，ListBox和Treeview有很多相似之处，在一些情况下基本可以替换使用，但是，这两个控件也有明显的区别。TreeView控件在建立选项的时候，使用的是TreeViewItem类，而TreeViewItem是HeaderedItemsControl(详细定义可以查看MSDN http://msdn.microsoft.com/en-us/library/system.windows.controls.treeviewitem(VS.95).aspx），作为HeaderedItemsControl，可以将控件选项内容赋值到Header或者HeaderTemplate属性中。这里，我们可以简单的理解，HeaderedItemsControl的Header/HeaderTemplate和ContentControl的Content/ContentTemplate功能是相同的，都是呈现内容的载体。所以，在ListBox中，选项是被绑定到ListBoxItem的content属性中，而在Treeview控件中，选项是被绑定到 TreeViewItem的Header属性中。同样，TreeView的ItemTemplate绑定也可以使用TreeviewItem的 HeaderTemplate属性进行绑定，结果是相同的。根据上面所述，可以得到下面的代码：

<UserControl x:Class="TreeviewDemo.MainPage"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
    xmlns:sys="clr-namespace:System;assembly=mscorlib"
    xmlns:Controls="clr-namespace:System.Windows.Controls;assembly=System.Windows.Controls" 
    mc:Ignorable="d" d:DesignWidth="640" d:DesignHeight="480">
  <Grid x:Name="LayoutRoot">
        <Controls:TreeView>
            <Controls:TreeViewItem Header="树型演示1">
                <Controls:TreeViewItem.HeaderTemplate>
                    <DataTemplate x:Name="myTemplate">
                        <TextBlock Foreground="Green" Text="{Binding}" />
                    </DataTemplate>
                </Controls:TreeViewItem.HeaderTemplate>
            </Controls:TreeViewItem>
            <Controls:TreeViewItem Header="树型演示2" HeaderTemplate="{Binding ElementName=myTemplate}" />
            <Controls:TreeViewItem Header="树型演示3" HeaderTemplate="{Binding ElementName=myTemplate}" />
        </Controls:TreeView>
    </Grid>
</UserControl>

运行结果和上面相同：

相信通过上面的演示，大家已经基本理解ItemsControl的Template使用，根据上述，我们可以延伸到 HierarchicalDataTemplate，使用HierarchicalDataTemplate我们需要建立一个例程数据类供 TreeView调用。

public class Country
{
    public Country()
    {
        Privinces = new ObservableCollection<Province>();
    }

    public string Name { get; set; }
    public ObservableCollection<Province> Privinces { get; set; }
}

public class Province
{
    public Province()
    {
        Citys = new ObservableCollection<City>();
    }

    public string Name { get; set; }
    public ObservableCollection<City> Citys { get; set; }
}

public class City
{
    public string Name { get; set; }
}

然后建立测试数据，代码如下：

tvDemo.ItemsSource = new ObservableCollection<Country> { 
    new Country { 
        Name = "中国", 
        Privinces = { new Province 
          { 
            Name="山东省",
            Citys = { 
                new City { Name = "济南市" },
                new City { Name= "淄博市" }
            }
          },
        new Province 
          { 
            Name="广东省", 
            Citys = { 
                new City { Name = "广州市" },
                new City { Name= "佛山市" }
            }
          }
       }
    },
    new Country { 
        Name = "加拿大", 
        Privinces = { new Province 
          { 
            Name="哥伦比亚省",
            Citys = { 
                new City { Name = "温哥华市" },
                new City { Name= "维多利亚市" }
            }
          },
        new Province 
          { 
            Name="阿尔伯塔省", 
            Citys = { 
                new City { Name = "埃德蒙顿市" },
                new City { Name= "卡尔加里市" }
            }
          }
       }
    }
};

首先我们使用TreeView的ItemTemplate来显示该数据树形结构，前台代码：

<Controls:TreeView x:Name="tvDemo">
    <Controls:TreeView.ItemTemplate>
       <DataTemplate>
                <TextBlock Text="{Binding Name}" />
       </DataTemplate>
    </Controls:TreeView.ItemTemplate>
</Controls:TreeView>

显示结果如下：

这里Treeview控件建立了两个TreeViewItems，并且绑定TreeViewitem的Header属性到Country对象，而且将TreeViewItem的HeaderTemplate设置为TreeView的ItemTemplate。下面，我们需要子数据同时绑定到 Treeview控件中，这里我们需要使用HierarchicalDataTemplate。在使用HierarchicalDataTemplate 前，需要声明新的命名空间：

xmlns:common="clr-namespace:System.Windows;assembly=System.Windows.Controls"

其实HierarchicalDataTemplate是一个带有多个扩展属性DataTemplate。如果我们不使用这些扩展属性，HierarchicalDataTemplate和普通DataTemplate是相同的，例如，我们修改上面代码：

<Controls:TreeView x:Name="tvDemo">
            <Controls:TreeView.ItemTemplate>
                <common:HierarchicalDataTemplate>
                    <TextBlock Text="{Binding Name}" />
                </common:HierarchicalDataTemplate>
            </Controls:TreeView.ItemTemplate>
</Controls:TreeView>

显示结果和上面相同：

所谓HierarchicalDataTemplate的扩展属性，主要是ItemsSource和ItemTemplate两个属性。其中 ItemsSource属性可以获取TreeView.ItemsSource的数据，ItemTemplate可以获取到 TreeViewItem.ItemTemplate模板。根据这两个属性，我们可以修改以上代码，获取到子数据。通常来说，我们会把 HierarchicalDataTemplate定义在Resource中，这样可以使代码布局整洁，另外提高易读性。

<UserControl.Resources>
    <common:HierarchicalDataTemplate x:Key="CityTemplate">
        <StackPanel>
            <TextBlock Text="{Binding Name}"/>
        </StackPanel>
    </common:HierarchicalDataTemplate>
    <common:HierarchicalDataTemplate x:Key="ProvinceTemplate" ItemsSource="{Binding Citys}" ItemTemplate="{StaticResource CityTemplate}">
        <StackPanel>
            <TextBlock Text="{Binding Name}" Foreground="Green"/>
        </StackPanel>
    </common:HierarchicalDataTemplate>
    <common:HierarchicalDataTemplate x:Key="CountryTemplate" ItemsSource="{Binding Privinces}" ItemTemplate="{StaticResource ProvinceTemplate}">
        <TextBlock Text="{Binding Name}" Foreground="Blue"/>
    </common:HierarchicalDataTemplate>
</UserControl.Resources>

在Resource中设置完HierarchicalDataTemplate，在TreeView控件中调用ItemTemplate就可以了。

<Controls:TreeView x:Name="tvDemo"  ItemTemplate="{StaticResource CountryTemplate}"></Controls:TreeView>

显示结果如下：

值得注意的是，在定义资源文件的时候，设置CityTemplate，ProvinceTemplate和CountryTemplate的顺序不能交换，否则无法查找到相关资源模板，同时，该资源文件也需要放在TreeView控件声明前，否则也是无法找到相关资源模板。

Silverlight C#

freedom - 2年前

共有0个回答按时间降序排列按时间升序排列按支持度排列

详解Silverlight Treeview的HierarchicalDataTemplate使用

相关的内容

Silverlight热门问题

C#热门问题