VirtualizingLayout Class

Definition

Namespace:

Microsoft.UI.Xaml.Controls

Represents the base class for an object that sizes and arranges child elements for a host and supports virtualization.

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.XamlContract, 65536)]
class VirtualizingLayout : Layout

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.XamlContract), 65536)]
public class VirtualizingLayout : Layout

Public Class VirtualizingLayout
Inherits Layout

Inheritance

Object IInspectable DependencyObject Layout VirtualizingLayout

Derived

Microsoft.UI.Xaml.Controls.LinedFlowLayout

Microsoft.UI.Xaml.Controls.StackLayout

Microsoft.UI.Xaml.Controls.UniformGridLayout

Attributes

MarshalingBehaviorAttribute ThreadingAttribute ContractVersionAttribute

Remarks

VirtualizingLayout is the base class for layouts that support virtualization. You can use one of the provided derived class, or inherit from it to create your own layout. Provided concrete virtualizing layout classes are StackLayout and UniformGridLayout.

Constructors

VirtualizingLayout()

Initializes a new instance of the VirtualizingLayout class.

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)
IndexBasedLayoutOrientation	Gets the orientation, if any, in which items are laid out based on their index in the source collection. (Inherited from Layout)

Methods

Arrange(LayoutContext, Size)	Positions child elements and determines a size for a container UIElement. Container elements that support attached layouts should call this method from their layout override implementations to form a recursive layout update. (Inherited from Layout)
ArrangeOverride(VirtualizingLayoutContext, Size)	When implemented in a derived class, provides the behavior for the "Arrange" pass of layout. Classes can override this method to define their own "Arrange" pass behavior.
ClearValue(DependencyProperty)	Clears the local value of a dependency property. (Inherited from DependencyObject)
CreateDefaultItemTransitionProvider()	(Inherited from Layout)
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)
InitializeForContext(LayoutContext)	Initializes any per-container state the layout requires when it is attached to a UIElement container. (Inherited from Layout)
InitializeForContextCore(VirtualizingLayoutContext)	When overridden in a derived class, initializes any per-container state the layout requires when it is attached to a UIElement container.
InvalidateArrange()	Invalidates the arrange state (layout) for all UIElement containers that reference this layout. After the invalidation, the UIElement will have its layout updated, which occurs asynchronously. (Inherited from Layout)
InvalidateMeasure()	Invalidates the measurement state (layout) for all UIElement containers that reference this layout. (Inherited from Layout)
Measure(LayoutContext, Size)	Suggests a DesiredSize for a container element. A container element that supports attached layouts should call this method from their own MeasureOverride implementations to form a recursive layout update. The attached layout is expected to call the Measure for each of the container’s UIElement children. (Inherited from Layout)
MeasureOverride(VirtualizingLayoutContext, Size)	Provides the behavior for the "Measure" pass of the layout cycle. Classes can override this method to define their own "Measure" pass behavior.
OnItemsChangedCore(VirtualizingLayoutContext, Object, NotifyCollectionChangedEventArgs)	Notifies the layout when the data collection assigned to the container element (ItemsSource) has changed.
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)
SetIndexBasedLayoutOrientation(IndexBasedLayoutOrientation)	Sets the value of the IndexBasedLayoutOrientation property. (Inherited from Layout)
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
UninitializeForContext(LayoutContext)	Removes any state the layout previously stored on the UIElement container. (Inherited from Layout)
UninitializeForContextCore(VirtualizingLayoutContext)	When overridden in a derived class, removes any state the layout previously stored on the UIElement container.
UnregisterPropertyChangedCallback(DependencyProperty, Int64)	Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject)

Events

ArrangeInvalidated	Occurs when the arrange state (layout) has been invalidated. (Inherited from Layout)
MeasureInvalidated	Occurs when the measurement state (layout) has been invalidated. (Inherited from Layout)