# WPF快速入門系列(7)——深入解析WPF模板 ## 一、引言 模板從字面意思理解是“具有一定規格的樣板"。在現實生活中，磚塊都是方方正正的，那是因為制作磚塊的模板是方方正正的，如果我們使模板為圓形的話，則制作出來的磚塊就是圓形的，此時我們并不能說圓形的”磚塊“不是磚塊吧。因為形狀只是它們的外觀，其制作材料還是一樣的。所以，模板可以理解為表現形式。WPF中的模板同樣是表現形式的意思。 在WPF中包括三種模板：控件模板、數據模版和面板模板。它們都繼承于[FrameworkTemplate](http://msdn.microsoft.com/zh-cn/library/system.windows.frameworktemplate(v=vs.110).aspx)基類，其繼承層次結果如下圖所示：  從上圖可以發現，FrameworkTemplate確實有三個子類，它們正是WPF中支持的三種模板。對于控件模板，即控件外觀外衣，可以通過修改控件模板來自定義控件的外觀表現，例如，可以通過修改按鈕的控件模板使按鈕表現為圓形；數據模板，即數據的外衣。用于從一個對象中提取數據，并在內容控件或列表控件的各個項中顯示數據。面板模板即面板的外衣，而面板又用于進行布局的，所以面板的外衣也就是布局的外衣，通過修改面板模板可以自定義控件的布局。例如，ListBox默認是自從向下地顯示每一項的，此時可以通過修改面板模板使其自左向右地顯示每一項。 WPF模板其實都是外觀的表現形式，不管是控件模板、數據模板還是面板模板，其都是改變控件的表現形式。只不過這三種控件的作用點不一樣罷了。控件模板是針對于控件本身，修改它可以改變控件本身表現的樣子；數據模板針對控件的數據，修改它可以改變控件綁定的數據表現樣子。既然是決定數據的表現，從而決定其一般應用于數據綁定控件，如ListBox、ListView等控件。面板模板則針對于控件的布局，修改它可以影響控件的布局方式。 ## 二、控件模板 在分別介紹這三種控件模板之前，我覺得你有必要先了解WPF的邏輯樹和可視化樹的內容，因為你要修改控件模板，則首先需要了解控件的組成。 ## 2.1 WPF的邏輯樹和可視化樹 在許多技術中，元素和組件都是按樹結構的形式進行組織的。使用這樣的結構，**開發人員可以直接操作樹中的對象節點來程序對象，從而通過操作該對象來修改程序的表現和行為（這是了解邏輯樹和可視化樹的主要原因）。**在WPF中，同樣使用了樹結構來組織元素之間的關系。WPF中支持邏輯樹和可視化樹的概念，并且WPF公開了兩個提供樹形視圖幫助器類：[LogicalTreeHelper](http://msdn.microsoft.com/zh-cn/library/system.windows.logicaltreehelper(v=vs.110).aspx) 和 [VisualTreeHelper](http://msdn.microsoft.com/zh-cn/library/system.windows.media.visualtreehelper(v=vs.110).aspx)。邏輯樹指的是UI界面的組成元素的結構。先看下面的XAML代碼的例子： ``` <Window x:Class="TemplateDemo.VisualTree" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" Title="MainWindow" Height="200" Width="300"> <StackPanel Margin="5"> <Button Padding="5" Margin="10">First Button</Button> <Button Padding="5" Margin="10">Second Button</Button> </StackPanel> </Window> ``` 上面XAML的邏輯樹如下圖所示：  可視化樹是邏輯樹的擴展版本，它將元素分成更小的部分。上面XAML代碼對應的可視化樹如下圖所示：  從上面可視化樹可以看出，Button由多個可視化元素組成——使按鈕具有陰影背景特征的邊框(由[ButtonChrome](http://msdn.microsoft.com/zh-cn/library/microsoft.windows.themes.buttonchrome(v=vs.110).aspx)類表示)、內部的容器(一個ContentPresenter對象)以及存儲按鈕文本的文本塊控件(由TextBlock表示)。上面的可視化樹和邏輯樹結構并不是我憑空想象出來的，而是有事實依據的，我們可以通過VisualTreeHelper類和LogicTreeHelper類提供的方法來查看窗口的可視化樹和邏輯樹，下面的例子實現了這個需求，具體的XAML實現如下所示： ``` <Window x:Class="TemplateDemo.Window1" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" Title="MainWindow" Height="380" Width="400"> <StackPanel Margin="5"> <Button Padding="5" Margin="5" Click="ShowLogicTree">Show Logic Tree Button</Button> <Button Padding="5" Margin="5" Click="ShowVisualTree">Show Visual Tree Button</Button> <!--TreeView控件用來顯示窗口的邏輯樹和可視化樹--> <TreeView Name="treeElements" Margin="5"></TreeView> </StackPanel> </Window> ``` 對應的后臺代碼實現入下所示： ``` public partial class Window1 : Window { public Window1() { InitializeComponent(); } // 把公共代碼抽象出一個方法，從而使代碼重用 public void ProcessElement(object obj, TreeViewItem item, TreeViewItem previousItem) { item.Header = obj.GetType().Name; item.IsExpanded = true; // 如果當前元素是第一個元素就添加到樹集合上 // 如果是內嵌元素，則添加到它的父節點上 if (previousItem == null) { treeElements.Items.Add(item); } else { previousItem.Items.Add(item); } } private void PrintLogicTree(object obj, TreeViewItem previousItem) { TreeViewItem item = new TreeViewItem(); ProcessElement(obj, item, previousItem); // 如果不是DependencyObject，則返回 if (!(obj is DependencyObject)) return; // 遞歸打印邏輯樹 foreach(object child in LogicalTreeHelper.GetChildren(obj as DependencyObject)) { // 這里為了避免死循環，因為TreeView的子元素包含Window1、StackPanel等控件 // 如果不加這個條件，控件會一直反復循環 if (child is TreeView) return; PrintLogicTree(child, item); } } private void PrintVisualTree(DependencyObject obj, TreeViewItem previousItem) { TreeViewItem item = new TreeViewItem(); ProcessElement(obj, item, previousItem); // 遞歸輸出視覺樹 for (int i = 0; i < VisualTreeHelper.GetChildrenCount(obj); i++) { if (obj is TreeView) return; PrintVisualTree(VisualTreeHelper.GetChild(obj, i), item); } } private void ShowLogicTree(object sender, RoutedEventArgs e) { treeElements.Items.Clear(); PrintLogicTree(this, null); } private void ShowVisualTree(object sender, RoutedEventArgs e) { treeElements.Items.Clear(); PrintVisualTree(this, null); } } ``` 程序的運行效果如下圖所示：  ## 2.2 通過控件模板自定義控件外觀 控件模板既然是控件的外衣，自然我們可以創建的新的控件模板，然后把新的控件模板應用到需要應用的控件中，這時候應用了新控件模板的控件，將會使用新的控件模板來渲染自身，從而改變控件的外觀。這也是自定義控件外觀的要旨。在WPF中按鈕的默認控件是長方形的，我們可以通過創建一個新的控件模板來改變按鈕的外觀，下面的例子就實現了通過控件模板的方式自定義了一個圓形的按鈕。具體的XAML代碼如下所示： ``` <Window x:Class="TemplateDemo.ControlTemplate" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" Title="ControlTemplate" Height="300" Width="300"> <Window.Resources> <!--定義控件模板，并使用key標記--> <ControlTemplate x:Key="roundButtonTemplate" TargetType="Button"> <Grid> <Ellipse Name="ell" Fill="Orange" Width="100" Height="100"></Ellipse> <!--使用模板綁定來綁定按鈕的內容--> <ContentPresenter Content="{TemplateBinding Button.Content}" VerticalAlignment="Center" HorizontalAlignment="Center"></ContentPresenter> </Grid> <!--定義模板觸發器--> <ControlTemplate.Triggers> <Trigger Property="IsMouseOver" Value="True"> <Setter TargetName="ell" Property="Fill" Value="Yellow"/> </Trigger> </ControlTemplate.Triggers> </ControlTemplate> </Window.Resources> <StackPanel Margin="10"> <Button Content="Round Button" Template="{StaticResource roundButtonTemplate}"></Button> </StackPanel> </Window> ``` 此時，你就可以看到按鈕是一個圓形的了，并且當鼠標移動到按鈕上時，會觸發模板觸發器來改變Ellipse的填充色，具體的運行效果如下圖所示：  從上面的控件模板的使用可知，它和創建自定義控件不同，在很多情況下，你不需要編寫自己的控件，你只是希望更改控件的外觀。使用控件面板非常簡單： * **首先在資源集合中創建一個ControlTemplate，并指定key標記** * **然后賦值到控件的Template屬性中。** ## 三、數據模板 數據模板是數據的外衣，數據模板是一段定義如何綁定數據對象的XAML標記，有兩種類型的控件支持數據模板： * 內容控件通過ContentTemplate屬性支持數據模板。內容模板用于顯示任何放在Content屬性中的內容。 * 列表控件，即繼承自ItemsControl類的控件，通過ItemPlate屬性支持數據模板。該模板用于顯示由ItemSource提供集合中的每一項。 基于列表的模板實際上是以內容控件模板為基礎的，因為列表中的每一項由一個內容控件包裝的。如ListBox控件的ListBoxItem元素。下面讓我們具體看看如何去創建一個數據模板吧。 ## 3.1 如何定義數據模板 具體的XAML代碼如下所示： ``` <Window x:Class="TemplateDemo.DataTemplate" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:local ="clr-namespace:TemplateDemo;assembly=TemplateDemo" Title="DataTemplate" Height="300" Width="300"> <Window.Resources> <!--創建數據模板--> <DataTemplate x:Key="personDataTem"> <Border Name="blueBorder" Margin="3" BorderThickness="3" BorderBrush="Blue" CornerRadius="5"> <Grid Margin="3"> <Grid.RowDefinitions> <RowDefinition></RowDefinition> <RowDefinition></RowDefinition> </Grid.RowDefinitions> <TextBlock Name="nametxt" FontWeight="Bold" Text="{Binding Path=Name}"></TextBlock> <TextBlock Grid.Row="1" Text="{Binding Path=Age}"></TextBlock> </Grid> </Border> <!--定義數據模板觸發器--> <DataTemplate.Triggers> <Trigger SourceName="blueBorder" Property="IsMouseOver" Value="True"> <Setter TargetName="blueBorder" Property="Background" Value="LightGray"/> <Setter TargetName="nametxt" Property="FontSize" Value="20"/> </Trigger> </DataTemplate.Triggers> </DataTemplate> </Window.Resources> <StackPanel Margin="5"> <ListBox Name="lstPerson" HorizontalContentAlignment="Stretch" ItemTemplate="{StaticResource personDataTem}"></ListBox> </StackPanel> </Window> ``` 其對應的后臺代碼如下所示： ``` public partial class DataTemplate : Window { ObservableCollection<Student> persons = new ObservableCollection<Student>() { new Student() { Name ="LearningHard", Age=25}, new Student() { Name ="HelloWorld", Age=22} }; public DataTemplate() { InitializeComponent(); lstPerson.ItemsSource = persons; } } public class Student : INotifyPropertyChanged { public string ID { get { return Guid.NewGuid().ToString(); } } public string Name { get; set; } public int Age { get; set; } public event PropertyChangedEventHandler PropertyChanged; public void OnPropertyChanged(PropertyChangedEventArgs e) { if (PropertyChanged != null) PropertyChanged(this, e); } } ``` 其運行效果如下圖所示：  從上面數據模板的創建可知，使用DataTemplate很簡單： * **首先在資源集合中創建一個數據模板，并設置key標簽。** * **然后將key賦值到控件的CellTemplate或ContentTemplate或ItemTemplate屬性上即可。** ## 3\. 2 數據模板與控件模板的關系 從上面的介紹可知，控件只是數據和行為的載體，至于它本身長什么樣子和數據長什么樣子都是靠Template決定的。決定控件外觀的是ControlTemplate，決定數據外觀的是DataTemplate，它們正是[Control](http://msdn.microsoft.com/zh-cn/library/system.windows.controls.control(v=vs.110).aspx)類的Template和ContentTemplate兩個屬性的值。 一般來說，ControlTemplate內都有一個ContentPresenter，這個ContentPresenter的ContentTemplate就是DataTemplate類型。所以數據模板和控件模板的關系如下圖所示：  ## 四、創建面板模板 ItemsPanelTemplate用于指定項的布局。 [ItemsControl](http://msdn.microsoft.com/zh-cn/library/system.windows.controls.itemscontrol(v=vs.110).aspx) 類型具有一個類型為ItemsPanelTemplate 的 [ItemsPanel](http://msdn.microsoft.com/zh-cn/library/system.windows.controls.itemscontrol.itemspanel(v=vs.110).aspx) 屬性。 每種ItemsControl都有其默認的ItemsPanelTemplate。ListBox, the default uses the VirtualizingStackPanel."&gt;對于 [ListBox](http://msdn.microsoft.com/zh-cn/library/system.windows.controls.listbox(v=vs.110).aspx)，默認值使用 [VirtualizingStackPanel](http://msdn.microsoft.com/zh-cn/library/system.windows.controls.virtualizingstackpanel(v=vs.110).aspx)。 MenuItem, the default uses WrapPanel."&gt;對于 [MenuItem](http://msdn.microsoft.com/zh-cn/library/system.windows.controls.menuitem(v=vs.110).aspx)，默認值使用 [WrapPanel](http://msdn.microsoft.com/zh-cn/library/system.windows.controls.wrappanel(v=vs.110).aspx)。 StatusBar, the default uses DockPanel."&gt;對于 [StatusBar](http://msdn.microsoft.com/zh-cn/library/system.windows.controls.primitives.statusbar(v=vs.110).aspx)，默認值使用 [DockPanel](http://msdn.microsoft.com/zh-cn/library/system.windows.controls.dockpanel(v=vs.110).aspx)。 ListBox, the default uses the VirtualizingStackPanel."&gt;MenuItem, the default uses WrapPanel."&gt;StatusBar, the default uses DockPanel."&gt;自定義面板模板與自定義數據面板和數據面板一樣簡單，一樣只需要首先定義一個面板模板在資源集合中，然后將其Key指定給ItemsPanel屬性即可。具體的XAML實現如下所示： ``` <Window x:Class="TemplateDemo.ItemsPanelTemplate" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" Title="ItemsPanelTemplate" Height="300" Width="300"> <Window.Resources> <!--定義DataTemplate--> <DataTemplate x:Key="personDataTem"> <Border Name="blueBorder" Margin="3" BorderThickness="3" BorderBrush="Blue" CornerRadius="5"> <Grid Margin="3"> <Grid.RowDefinitions> <RowDefinition></RowDefinition> <RowDefinition></RowDefinition> </Grid.RowDefinitions> <TextBlock Name="nametxt" FontWeight="Bold" Text="{Binding Path=Name}"></TextBlock> <TextBlock Grid.Row="1" Text="{Binding Path=Age}"></TextBlock> </Grid> </Border> </DataTemplate> <!--定義ItemsPanelTemplate--> <ItemsPanelTemplate x:Key="listItemsPanelTem"> <StackPanel Orientation="Horizontal" VerticalAlignment="Center" HorizontalAlignment="Left"/> </ItemsPanelTemplate> </Window.Resources> <!--使用ItemsPanelTemplate只需要賦值給ItemsPanel屬性即可--> <ListBox Name="lstPerson" ItemsPanel="{StaticResource listItemsPanelTem}" ItemTemplate="{StaticResource personDataTem}" /> </Window> ``` 其后臺代碼和數據模板的后臺代碼一樣，其實現代碼為： ``` public partial class ItemsPanelTemplate : Window { ObservableCollection<Student> persons = new ObservableCollection<Student>() { new Student() { Name ="LearningHard", Age=25}, new Student() { Name ="HelloWorld", Age=22} }; public ItemsPanelTemplate() { InitializeComponent(); lstPerson.ItemsSource = persons; } } ``` 此時程序運行的效果如下圖所示，從下圖結果可以看出，此時ListBox中的項不再是自上而下排列了，而是從左向右排列的。  ## 五、總結 到這里，WPF模板的內容就介紹結束了，本文主要介紹了WPF中支持的三種模板：控件模板、數據模板和面板模板，然后各自定義并使用了自定義的模板，最后介紹了這三個模板之間的聯系。使用這三個模板的方式都非常簡單，**都是先定義一個模板，然后在把對應的key應用到控件對應的屬性中，對于控件模板，應用的是控件的Template，對于數據模板，應用的是控件的ItemTemplate屬性，對于面板模板，應用的是控件的ItemsPanel屬性。**在下面的一篇博文將介紹如何實現一個MVVM的實例程序。 本文所有源碼下載：[TemplateDemo.zip](http://files.cnblogs.com/zhili/TemplateDemo.zip)