HierarchicalDataTemplate Class

 

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

Namespace:   System.Windows
Assembly:  PresentationFramework (in PresentationFramework.dll)

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

public class HierarchicalDataTemplate : DataTemplate

NameDescription
System_CAPS_pubmethodHierarchicalDataTemplate()

Initializes a new instance of the HierarchicalDataTemplate class.

System_CAPS_pubmethodHierarchicalDataTemplate(Object)

Initializes a new instance of the HierarchicalDataTemplate class with the specified type for which the template is intended.

NameDescription
System_CAPS_pubpropertyAlternationCount

Gets or sets the number of alternating item containers for the child items.

System_CAPS_pubpropertyDataTemplateKey

Gets the default key of the DataTemplate. (Inherited from DataTemplate.)

System_CAPS_pubpropertyDataType

Gets or sets the type for which this DataTemplate is intended. (Inherited from DataTemplate.)

System_CAPS_pubpropertyDispatcher

Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)

System_CAPS_pubpropertyHasContent

Gets a value that indicates whether this template has optimized content.(Inherited from FrameworkTemplate.)

System_CAPS_pubpropertyIsSealed

Gets a value that indicates whether this object is in an immutable state so it cannot be changed.(Inherited from FrameworkTemplate.)

System_CAPS_pubpropertyItemBindingGroup

Gets or sets the BindingGroup that is copied to each child item.

System_CAPS_pubpropertyItemContainerStyle

Gets or sets the Style that is applied to the item container for each child item.

System_CAPS_pubpropertyItemContainerStyleSelector

Gets or sets custom style-selection logic for a style that can be applied to each item container.

System_CAPS_pubpropertyItemsSource

Gets or sets the binding for this data template, which indicates where to find the collection that represents the next level in the data hierarchy.

System_CAPS_pubpropertyItemStringFormat

Gets 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.

System_CAPS_pubpropertyItemTemplate

Gets 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.

System_CAPS_pubpropertyItemTemplateSelector

Gets 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.

System_CAPS_pubpropertyResources

Gets or sets the collection of resources that can be used within the scope of this template.(Inherited from FrameworkTemplate.)

System_CAPS_pubpropertyTemplate

Gets 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.)

System_CAPS_pubpropertyTriggers

Gets a collection of triggers that apply property values or perform actions based on one or more conditions.(Inherited from DataTemplate.)

System_CAPS_pubpropertyVisualTree

Gets or sets the root node of the template.(Inherited from FrameworkTemplate.)

NameDescription
System_CAPS_pubmethodCheckAccess()

Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFindName(String, FrameworkElement)

Finds the element associated with the specified name defined within this template.(Inherited from FrameworkTemplate.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodLoadContent()

Loads the content of the template as an instance of an object and returns the root element of the content.(Inherited from FrameworkTemplate.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodRegisterName(String, Object)

Registers a new name/object pair into the current name scope.(Inherited from FrameworkTemplate.)

System_CAPS_pubmethodSeal()

Locks the template so it cannot be changed.(Inherited from FrameworkTemplate.)

System_CAPS_pubmethodShouldSerializeResources(XamlDesignerSerializationManager)

Returns a value that indicates whether serialization processes should serialize the value of the Resources property on instances of this class.(Inherited from FrameworkTemplate.)

System_CAPS_pubmethodShouldSerializeVisualTree()

Returns a value that indicates whether serialization processes should serialize the value of the VisualTree property on instances of this class.(Inherited from FrameworkTemplate.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodUnregisterName(String)

Removes a name/object mapping from the XAML namescope.(Inherited from FrameworkTemplate.)

System_CAPS_protmethodValidateTemplatedParent(FrameworkElement)

Checks the templated parent against a set of rules.(Inherited from DataTemplate.)

System_CAPS_pubmethodVerifyAccess()

Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodINameScope.FindName(String)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns an object that has the provided identifying name. (Inherited from FrameworkTemplate.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIQueryAmbient.IsAmbientPropertyAvailable(String)

Queries whether a specified ambient property is available in the current scope.(Inherited from FrameworkTemplate.)

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

.NET Framework
Available since 3.0
Silverlight
Available since 3.0
Windows Phone Silverlight
Available since 7.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: