FrameworkTemplate Class

Reference

Definition

Namespace:: Microsoft.UI.Xaml

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Creates an element tree of elements. FrameworkTemplate is a base class for classes that have specific templating behavior, including ControlTemplate and DataTemplate.

public ref class FrameworkTemplate : DependencyObject

/// [Microsoft.UI.Xaml.Markup.ContentProperty(Name="Template")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.WinUIContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class FrameworkTemplate : DependencyObject

[Microsoft.UI.Xaml.Markup.ContentProperty(Name="Template")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class FrameworkTemplate : DependencyObject

Public Class FrameworkTemplate
Inherits DependencyObject

Inheritance: Object Platform::Object IInspectable DependencyObject FrameworkTemplate

Derived: Microsoft.UI.Xaml.Controls.ControlTemplate

Microsoft.UI.Xaml.Controls.ItemsPanelTemplate

Microsoft.UI.Xaml.DataTemplate

Attributes: ContentPropertyAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Remarks

FrameworkTemplate has a ContentPropertyAttribute that indicates that its XAML content property is named "Template". FrameworkTemplate doesn't define a property of that name, nor do its derived types that have a practical usage (ControlTemplate, DataTemplate). The content of a FrameworkTemplate is a root element that should be created when the template is applied to the object being templated, and isn't a conventional property in the object model. Content of a FrameworkTemplate is handled specially by the XAML parser when content is created from a template.

For more info on how to use templates, see ControlTemplate and XAML Control templates.

FrameworkTemplate derived classes

FrameworkTemplate is the parent class for several immediately derived classes that each define specific templating behavior. Here are some of the notable derived classes:

ControlTemplate: this is used as the value of the Control.Template property, which defines the visuals of a control by applying the template. You almost always define a ControlTemplate as a XAML resource, using an implicit key TargetType that is the same as a Style that sets Control.Template with a Setter. You rarely if ever assign a value for Control.Template directly on a control instance.
DataTemplate: specifies the visual representation of your data when it's supplying items for an items control, such as a ListView or GridView. A DataTemplate sets the ItemTemplate property for an items control. DataTemplate is also used for ContentControl.ContentTemplate and other control-specific data templating properties, such as various Header, HeaderTemplate, ContentTemplate and ItemTemplate properties on multiple classes.
ItemsPanelTemplate: supports an alternative technique for representing data in the visuals of a control, by defining a layout container as well as parts within that container that present the data. ItemsPanelTemplate is used as the value of ItemsControl.ItemsPanel for items controls.

Constructors

FrameworkTemplate()

Provides base class initialization behavior for FrameworkTemplate-derived classes.

Properties

Dispatcher	Always returns `null` in a Windows App SDK app. Use DispatcherQueue instead. (Inherited from DependencyObject)
DispatcherQueue	Gets the `DispatcherQueue` that this object is associated with. The `DispatcherQueue` represents a facility that can access the `DependencyObject` on the UI thread even if the code is initiated by a non-UI thread. (Inherited from DependencyObject)

Methods

ClearValue(DependencyProperty)	Clears the local value of a dependency property. (Inherited from DependencyObject)
GetAnimationBaseValue(DependencyProperty)	Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetValue(DependencyProperty)	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)	Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. (Inherited from DependencyObject)
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)	Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject)

Applies to