DataTemplateSelector Class
Definition
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.
Enables custom template selection logic at the application level.
/// [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 DataTemplateSelector : IElementFactory[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 DataTemplateSelector : IElementFactoryPublic Class DataTemplateSelector
Implements IElementFactorySee Remarks
- Inheritance
- Attributes
- Implements
Remarks
For more info and examples, see Data template selection. For more general info about data templates, see the DataTemplate class and Item containers and templates.
The base DataTemplateSelector class is not used as an object element in XAML. However, it is a common scenario to derive a custom DataTemplateSelector, map a xmlns prefix for the custom class and its namespace/assembly, and then refer to an instance of the custom class as defined in a Resources block in XAML. This makes it possible to refer to the custom template selector class by x:Key, and use that reference to set the value of properties such as ItemTemplateSelector in XAML templates and visual states.
The callable methods of DataTemplateSelector are the two SelectTemplate overloads. The overridable methods of DataTemplateSelector are the two SelectTemplateCore overloads. To define an effective DataTemplateSelector subclass, provide implementations for SelectTemplateCore(Object) and SelectTemplateCore(Object, DependencyObject). All these methods return a DataTemplate instance that's typically a specific choice that's appropriate for the inputs of the method that was called to obtain it.
App code typically doesn't call SelectTemplate methods; the methods exists so that the infrastructure can call it while choosing the correct templates based on using a DataTemplateSelector instance from a property value such as ItemsControl.ItemsTemplateSelector.
For example XAML that references a custom DataTemplateSelector as the HeaderTemplateSelector value, and example code that shows the overrides for HeaderTemplateSelector methods, see How to group items in a list or grid.
Constructors
| DataTemplateSelector() |
Initializes a new instance of the DataTemplateSelector class. |
Methods
| GetElement(ElementFactoryGetArgs) |
Creates or retrieves an existing instance of the UIElement object declared in the DataTemplate returned by SelectTemplate. |
| RecycleElement(ElementFactoryRecycleArgs) |
Recycles a UIElement object that was created using GetElement. |
| SelectTemplate(Object, DependencyObject) |
Returns a specific DataTemplate for a given item and container. |
| SelectTemplate(Object) |
Returns a specific DataTemplate for a given item. |
| SelectTemplateCore(Object, DependencyObject) |
When implemented by a derived class, returns a specific DataTemplate for a given item or container. |
| SelectTemplateCore(Object) |
When implemented by a derived class, returns a specific DataTemplate for a given item or container. |