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

DataTemplate Class

Describes the visual structure of a data object.

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
[DictionaryKeyPropertyAttribute("DataTemplateKey")]
public class DataTemplate : FrameworkTemplate
<DataTemplate>
  VisualTree
</DataTemplate>

The DataTemplate type exposes the following members.

  NameDescription
Public methodDataTemplate()Initializes a new instance of the DataTemplate class.
Public methodDataTemplate(Object)Initializes a new instance of the DataTemplate class with the specified DataType property.
Top
  NameDescription
Public propertyDataTemplateKeyGets the default key of the DataTemplate.
Public propertyDataTypeGets or sets the type for which this DataTemplate is intended.
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 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.
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 a hash function for a particular type. (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. (Overrides FrameworkTemplate.ValidateTemplatedParent(FrameworkElement).)
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

You use a DataTemplate to specify the visualization of your data objects. DataTemplate objects are particularly useful when you are binding an ItemsControl such as a ListBox to an entire collection. Without specific instructions, a ListBox displays the string representation of the objects in a collection. In that case, you can use a DataTemplate to define the appearance of your data objects. The content of your DataTemplate becomes the visual structure of your data objects.

For an in-depth discussion, see Data Templating Overview.

The following example shows how to create a DataTemplate inline. The DataTemplate specifies that each data item appears as three TextBlock elements within a StackPanel. In this example, the data object is a class called Task. Note that each TextBlock element in this template is bound to a property of the Task class.


<ListBox Width="400" Margin="10"
         ItemsSource="{Binding Source={StaticResource myTodoList}}">
   <ListBox.ItemTemplate>
     <DataTemplate>
       <StackPanel>
         <TextBlock Text="{Binding Path=TaskName}" />
         <TextBlock Text="{Binding Path=Description}"/>
         <TextBlock Text="{Binding Path=Priority}"/>
       </StackPanel>
     </DataTemplate>
   </ListBox.ItemTemplate>
 </ListBox>


It is more common to define a DataTemplate in the resources section so it can be a reusable object, as in the following example:


<Window.Resources>


...


<DataTemplate x:Key="myTaskTemplate">
  <StackPanel>
    <TextBlock Text="{Binding Path=TaskName}" />
    <TextBlock Text="{Binding Path=Description}"/>
    <TextBlock Text="{Binding Path=Priority}"/>
  </StackPanel>
</DataTemplate>


...


</Window.Resources>


Now you can use myTaskTemplate as a resource, as in the following example:


<ListBox Width="400" Margin="10"
         ItemsSource="{Binding Source={StaticResource myTodoList}}"
         ItemTemplate="{StaticResource myTaskTemplate}"/>


For the complete sample, see Introduction to Data Templating Sample.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.