DataTemplate.GetElement(ElementFactoryGetArgs) DataTemplate.GetElement(ElementFactoryGetArgs) DataTemplate.GetElement(ElementFactoryGetArgs) DataTemplate.GetElement(ElementFactoryGetArgs) Method

Definition

Creates or retrieves an existing instance of the UIElement object declared in the DataTemplate.

public : UIElement GetElement(ElementFactoryGetArgs args)
UIElement GetElement(ElementFactoryGetArgs args) const;
public UIElement GetElement(ElementFactoryGetArgs args)
Public Function GetElement(args As ElementFactoryGetArgs) As UIElement

Parameters

Returns

An instance of the root UIElement declared in the DataTemplate or null if the root of the DataTemplate is not a UIElement.

Additional features and requirements

Device family
Windows 10, version 1809 (introduced v10.0.17763.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v7)

Remarks

The DataTemplate acts as a factory that generates the element object declared in its template. Unlike the LoadContent method that creates a new instance every time it is invoked, the GetElement method may either create a new instance or return an existing instance that was recycled via RecycleElement.

The DataTemplate's implementation of GetElement does not use the Data value from the ElementFactoryGetArgs. The Data property exists for implementations such as DataTemplateSelector where it is used to decide from which DataTemplate to load content.

See also

  • T:Windows.UI.Xaml.IElementFactory * DataTemplate * GetElement * M:Windows.UI.Xaml.DataTemplate.RecycleElement(Windows.UI.Xaml.ElementFactoryRecycleArgs) * DataTemplateSelector * M:Windows.UI.Xaml.Controls.DataTemplateSelector.GetElement(Windows.UI.Xaml.ElementFactoryGetArgs) * M:Windows.UI.Xaml.Controls.DataTemplateSelector.RecycleElement(Windows.UI.Xaml.ElementFactoryRecycleArgs)