ItemsRepeater Class

Definition

Namespace:

Microsoft.UI.Xaml.Controls

Represents a data-driven collection control that incorporates a flexible layout system, custom views, and virtualization, with no default UI or interaction policies.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

/// [Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallbackMethodName(value="OnPropertyChanged")]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.UI.Xaml.Markup.ContentProperty(Name="ItemTemplate")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.XamlContract, 65536)]
class ItemsRepeater : FrameworkElement

[Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallbackMethodName(value="OnPropertyChanged")]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.UI.Xaml.Markup.ContentProperty(Name="ItemTemplate")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.XamlContract), 65536)]
public class ItemsRepeater : FrameworkElement

Public Class ItemsRepeater
Inherits FrameworkElement

Inheritance

FrameworkElement

ItemsRepeater

Attributes

Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallbackMethodNameAttribute MarshalingBehaviorAttribute ThreadingAttribute ContentPropertyAttribute ContractVersionAttribute

Examples

Tip

For more info, design guidance, and code examples, see Items repeater.

Open the WinUI 2 Gallery app and see the ItemsRepeater in action.

The WinUI 2 Gallery app includes interactive examples of most WinUI 2 controls, features, and functionality. Get the app from the Microsoft Store or get the source code on GitHub.

Remarks

While an ItemsRepeater can be used to present a basic set of items, it is typically just a building block for your own unique collection-based experiences, and is most often used as the display element in the template of a custom control.

ItemsRepeater supports virtualization when attached to a host that supports virtualization.

Constructors

ItemsRepeater()

Initializes a new instance of the ItemsRepeater class. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Properties

Background	Gets or sets a brush that provides the background of the control. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
BackgroundProperty	Identifies the Background dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
HorizontalCacheLength	Gets or sets a value that indicates the size of the buffer used to realize items when panning or scrolling horizontally. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
HorizontalCacheLengthProperty	Identifies the HorizontalCacheLength dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
ItemsSource	Gets or sets an object source used to generate the content of the ItemsRepeater. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
ItemsSourceProperty	Identifies the ItemsSource dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
ItemsSourceView	Gets a standardized view of the supported interactions between a given ItemsSource object and the ItemsRepeater control and its associated components. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
ItemTemplate	Gets or sets the template used to display each item. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
ItemTemplateProperty	Identifies the ItemTemplate dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
Layout	Gets or sets the layout used to size and position elements in the ItemsRepeater. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
LayoutProperty	Identifies the Layout dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
VerticalCacheLength	Gets or sets a value that indicates the size of the buffer used to realize items when panning or scrolling vertically. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
VerticalCacheLengthProperty	Identifies the VerticalCacheLength dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Methods

GetElementIndex(UIElement)	Retrieves the index of the item from the data source that corresponds to the specified UIElement. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
GetOrCreateElement(Int32)	Retrieves the UIElement that corresponds to the item at the specified index in the data source. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
TryGetElement(Int32)	Retrieves the realized UIElement that corresponds to the item at the specified index in the data source. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Events

ElementClearing	Occurs each time an element is cleared and made available to be re-used. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
ElementIndexChanged	Occurs for each realized UIElement when the index for the item it represents has changed. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
ElementPrepared	Occurs each time an element is prepared for use. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

See also

• ItemsRepeater guidelines