Export (0) Print
Expand All
0 out of 4 rated this helpful - Rate this topic

HierarchicalDataTemplate Class

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
public class HierarchicalDataTemplate : DataTemplate
<HierarchicalDataTemplate>
  VisualTree
</HierarchicalDataTemplate>

The HierarchicalDataTemplate type exposes the following members.

  NameDescription
Public methodHierarchicalDataTemplate()Initializes a new instance of the HierarchicalDataTemplate class.
Public methodHierarchicalDataTemplate(Object)Initializes a new instance of the HierarchicalDataTemplate class with the specified type for which the template is intended.
Top
  NameDescription
Public propertyAlternationCountGets or sets the number of alternating item containers for the child items.
Public propertyDataTemplateKeyGets the default key of the DataTemplate. (Inherited from DataTemplate.)
Public propertyDataTypeGets or sets the type for which this DataTemplate is intended. (Inherited from DataTemplate.)
Public propertyDispatcherGets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public propertyHasContentGets a value that indicates whether this template has optimized content. (Inherited from FrameworkTemplate.)
Public propertyIsSealedGets a value that indicates whether this object is in an immutable state so it cannot be changed. (Inherited from FrameworkTemplate.)
Public propertyItemBindingGroupGets or sets the BindingGroup that is copied to each child item.
Public propertyItemContainerStyleGets or sets the Style that is applied to the item container for each child item.
Public propertyItemContainerStyleSelectorGets or sets custom style-selection logic for a style that can be applied to each item container.
Public propertyItemsSourceGets or sets the binding for this data template, which indicates where to find the collection that represents the next level in the data hierarchy.
Public propertyItemStringFormatGets or sets a composite string that specifies how to format the items in the next level in the data hierarchy if they are displayed as strings.
Public propertyItemTemplateGets or sets the DataTemplate to apply to the ItemTemplate property on a generated HeaderedItemsControl (such as a MenuItem or a TreeViewItem), to indicate how to display items from the next level in the data hierarchy.
Public propertyItemTemplateSelectorGets or sets the DataTemplateSelector to apply to the ItemTemplateSelector property on a generated HeaderedItemsControl (such as a MenuItem or a TreeViewItem), to indicate how to select a template to display items from the next level in the data hierarchy.
Public propertyResourcesGets or sets the collection of resources that can be used within the scope of this template. (Inherited from FrameworkTemplate.)
Public propertyTemplateGets or sets a reference to the object that records or plays the XAML nodes for the template when the template is defined or applied by a writer. (Inherited from FrameworkTemplate.)
Public propertyTriggersGets a collection of triggers that apply property values or perform actions based on one or more conditions. (Inherited from DataTemplate.)
Public propertyVisualTreeGets or sets the root node of the template. (Inherited from FrameworkTemplate.)
Top
  NameDescription
Public methodCheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFindNameFinds the element associated with the specified name defined within this template. (Inherited from FrameworkTemplate.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodLoadContentLoads the content of the template as an instance of an object and returns the root element of the content. (Inherited from FrameworkTemplate.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRegisterNameRegisters a new name/object pair into the current name scope. (Inherited from FrameworkTemplate.)
Public methodSealLocks the template so it cannot be changed. (Inherited from FrameworkTemplate.)
Public methodShouldSerializeResourcesReturns a value that indicates whether serialization processes should serialize the value of the Resources property on instances of this class. (Inherited from FrameworkTemplate.)
Public methodShouldSerializeVisualTreeReturns a value that indicates whether serialization processes should serialize the value of the VisualTree property on instances of this class. (Inherited from FrameworkTemplate.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodUnregisterNameRemoves a name/object mapping from the XAML namescope. (Inherited from FrameworkTemplate.)
Protected methodValidateTemplatedParentChecks the templated parent against a set of rules. (Inherited from DataTemplate.)
Public methodVerifyAccessEnforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Top
  NameDescription
Explicit interface implemetationPrivate methodINameScope.FindNameInfrastructure. Returns an object that has the provided identifying name. (Inherited from FrameworkTemplate.)
Explicit interface implemetationPrivate methodIQueryAmbient.IsAmbientPropertyAvailableQueries whether a specified ambient property is available in the current scope. (Inherited from FrameworkTemplate.)
Top

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.

<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

More Code

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

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.