StackLayout Class

Definition

Namespace:

Microsoft.UI.Xaml.Controls

Represents an attached layout that arranges child elements into a single line that can be oriented horizontally or vertically.

/// [Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallback(enable=true)]
/// [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.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.XamlContract, 65536)]
class StackLayout : VirtualizingLayout

[Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallback(enable=true)]
[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.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.XamlContract), 65536)]
public class StackLayout : VirtualizingLayout

Public Class StackLayout
Inherits VirtualizingLayout

Inheritance

DependencyObject

Layout

VirtualizingLayout

StackLayout

Attributes

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

Remarks

StackLayout is a virtualizing layout that can be used with element containers that support Attached layouts, such as ItemsRepeater. Its behavior is similar to the ItemsStackPanel control.

Constructors

StackLayout()

Initializes a new instance of the StackLayout class.

Properties

Orientation	Gets or sets the dimension by which child elements are stacked.
OrientationProperty	Identifies the Orientation dependency property.
Spacing	Gets or sets a uniform distance (in pixels) between stacked items. It is applied in the direction of the StackLayout's Orientation.
SpacingProperty	Identifies the Spacing dependency property.

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. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). (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. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). (Inherited from VirtualizingLayout)
InitializeForContext(LayoutContext)	Initializes any per-container state the layout requires when it is attached to a UIElement container. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). (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. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). (Inherited from VirtualizingLayout)
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. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). (Inherited from Layout)
InvalidateMeasure()	Invalidates the measurement state (layout) for all UIElement containers that reference this layout. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). (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. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). (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. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). (Inherited from VirtualizingLayout)
OnItemsChangedCore(VirtualizingLayoutContext, Object, NotifyCollectionChangedEventArgs)	Notifies the layout when the data collection assigned to the container element (ItemsSource) has changed. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). (Inherited from VirtualizingLayout)
UninitializeForContext(LayoutContext)	Removes any state the layout previously stored on the UIElement container. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). (Inherited from Layout)
UninitializeForContextCore(VirtualizingLayoutContext)	When overridden in a derived class, removes any state the layout previously stored on the UIElement container. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). (Inherited from VirtualizingLayout)

Events

ArrangeInvalidated	Occurs when the arrange state (layout) has been invalidated. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). (Inherited from Layout)
MeasureInvalidated	Occurs when the measurement state (layout) has been invalidated. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). (Inherited from Layout)