Arranges and virtualizes content on a single line that is oriented either horizontally or vertically. Can only be used to display items in an ItemsControl.
Inheritance
- Object
- DependencyObject
- UIElement
- FrameworkElement
- Panel
- VirtualizingPanel
- OrientedVirtualizingPanel
- VirtualizingStackPanel
Syntax
public sealed class VirtualizingStackPanel : OrientedVirtualizingPanel, IScrollSnapPointsInfo
<VirtualizingStackPanel .../> -or- <VirtualizingStackPanel ...> oneOrMoreChildren </VirtualizingStackPanel>
XAML Values
- oneOrMoreChildren
-
One or more object elements of types that derive from UIElement, which are contained by this VirtualizingStackPanel. See Children.
Attributes
- ActivatableAttribute(NTDDI_WIN8)
- MarshalingBehaviorAttribute(Agile)
- StaticAttribute(Windows.UI.Xaml.Controls.IVirtualizingStackPanelStatics, NTDDI_WIN8)
- ThreadingAttribute(Both)
- VersionAttribute(NTDDI_WIN8)
- WebHostHiddenAttribute()
Members
The VirtualizingStackPanel class has these types of members:
Constructors
The VirtualizingStackPanel class has these constructors.
| Constructor | Description |
|---|---|
| VirtualizingStackPanel | Initializes a new instance of the VirtualizingStackPanel class. |
Events
The VirtualizingStackPanel class has these events.
| Event | Description |
|---|---|
| CleanUpVirtualizedItemEvent | Occurs when an item that is hosted by the VirtualizingStackPanel is re-virtualized. |
| DoubleTapped | Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element. (Inherited from UIElement) |
| DragEnter | Occurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement) |
| DragLeave | Occurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement) |
| DragOver | Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement) |
| Drop | Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement) |
| GotFocus | Occurs when a UIElement receives focus. (Inherited from UIElement) |
| Holding | Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element. (Inherited from UIElement) |
| HorizontalSnapPointsChanged | Fires when the measurements for horizontal snap points change. (Inherited from OrientedVirtualizingPanel) |
| KeyDown | Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement) |
| KeyUp | Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement) |
| LayoutUpdated | Occurs when the layout of the visual tree changes. (Inherited from FrameworkElement) |
| Loaded | Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction. (Inherited from FrameworkElement) |
| LostFocus | Occurs when a UIElement loses focus. (Inherited from UIElement) |
| ManipulationCompleted | Occurs when a manipulation on the UIElement is complete. (Inherited from UIElement) |
| ManipulationDelta | Occurs when the input device changes position during a manipulation. (Inherited from UIElement) |
| ManipulationInertiaStarting | Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins. (Inherited from UIElement) |
| ManipulationStarted | Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement) |
| ManipulationStarting | Occurs when the manipulation processor is first created. (Inherited from UIElement) |
| PointerCanceled | Occurs when a pointer that made contact abnormally loses contact. (Inherited from UIElement) |
| PointerCaptureLost | Occurs when pointer capture previously held by this element moves to another element or elsewhere. (Inherited from UIElement) |
| PointerEntered | Occurs when a pointer enters the hit test area of this element. (Inherited from UIElement) |
| PointerExited | Occurs when a pointer leaves the hit test area of this element. (Inherited from UIElement) |
| PointerMoved | Occurs when a pointer moves while the pointer remains within the hit test area of this element. (Inherited from UIElement) |
| PointerPressed | Occurs when the pointer device initiates a Press action within this element. (Inherited from UIElement) |
| PointerReleased | Occurs when the pointer device that previously initiated a Press action is released, while within this element. (Inherited from UIElement) |
| PointerWheelChanged | Occurs when the delta value of a pointer wheel changes. (Inherited from UIElement) |
| RightTapped | Occurs when a right-tap input stimulus happens while the pointer is over the element. (Inherited from UIElement) |
| SizeChanged | Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement. (Inherited from FrameworkElement) |
| Tapped | Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element. (Inherited from UIElement) |
| Unloaded | Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement) |
| VerticalSnapPointsChanged | Fires when the measurements for vertical snap points change. (Inherited from OrientedVirtualizingPanel) |
Methods
The VirtualizingStackPanel class has these methods. It also inherits methods from the Object class.
| Method | Description |
|---|---|
| AddHandler | Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked even if the event is handled elsewhere. (Inherited from UIElement) |
| AddInternalChild | Adds the specified UIElement to the Children collection of a VirtualizingPanel element. (Inherited from VirtualizingPanel) |
| Arrange | Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update. (Inherited from UIElement) |
| ArrangeOverride | Provides the behavior for the Arrange pass of layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement) |
| BringIndexIntoView | Generates the item at the specified index location and makes it visible. (Inherited from VirtualizingPanel) |
| CapturePointer | Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events. (Inherited from UIElement) |
| ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject) |
| FindName | Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement) |
| FindSubElementsForTouchTargeting | Enables a UIElement subclass to expose child elements that assist with resolving touch targeting. (Inherited from UIElement) |
| GetAnimationBaseValue | Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject) |
| GetIrregularSnapPoints | Returns the set of distances between irregular snap points for a specified orientation and alignment. (Inherited from OrientedVirtualizingPanel) |
| GetIsVirtualizing | Gets a value that determines whether an item is currently being virtualized as part of an items set where the ItemsPanel is templated with a VirtualizingStackPanel. |
| GetRegularSnapPoints | Gets the distance between regular snap points for a specified orientation and alignment. (Inherited from OrientedVirtualizingPanel) |
| GetValue | Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject) |
| GetVirtualizationMode | Gets the VirtualizingStackPanel.VirtualizationMode XAML attached property value for the specified target element. |
| InsertInternalChild | Adds the specified UIElement to the collection of a VirtualizingPanel element at the specified index position. (Inherited from VirtualizingPanel) |
| InvalidateArrange | Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement) |
| InvalidateMeasure | Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement) |
| LineDown | Scrolls content by one line toward the bottom. (Inherited from OrientedVirtualizingPanel) |
| LineLeft | Scrolls content by one line toward the left. (Inherited from OrientedVirtualizingPanel) |
| LineRight | Scrolls content by one line toward the right. (Inherited from OrientedVirtualizingPanel) |
| LineUp | Scrolls content by one line toward the top. (Inherited from OrientedVirtualizingPanel) |
| MakeVisible | Changes existing offsets in order to make the provided element visible in the viewport, and returns a Rect measurement of the area. (Inherited from OrientedVirtualizingPanel) |
| Measure | Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update. (Inherited from UIElement) |
| MeasureOverride | Provides the behavior for the Measure pass of the layout cycle. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement) |
| MouseWheelDown | Scrolls content by one mouse-wheel click toward the bottom. (Inherited from OrientedVirtualizingPanel) |
| MouseWheelLeft | Scrolls content by one mouse-wheel click toward the left. (Inherited from OrientedVirtualizingPanel) |
| MouseWheelRight | Scrolls content by one mouse-wheel click toward the right. (Inherited from OrientedVirtualizingPanel) |
| MouseWheelUp | Scrolls content by one mouse-wheel click toward the top. (Inherited from OrientedVirtualizingPanel) |
| OnApplyTemplate | Invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in your app. Override this method to influence the default post-template logic of a class. (Inherited from FrameworkElement) |
| OnCleanUpVirtualizedItem | Called when an item that is hosted by the VirtualizingStackPanel is re-virtualized. |
| OnClearChildren | Called when the collection of child elements is cleared by the base Panel class. (Inherited from VirtualizingPanel) |
| OnCreateAutomationPeer | When implemented in a derived class, returns class-specific AutomationPeer implementations for the Microsoft UI Automation infrastructure. (Inherited from UIElement) |
| OnDisconnectVisualChildren | Override this method to implement how layout and logic should behave when items are removed from a class-specific content or children property. (Inherited from UIElement) |
| OnItemsChanged | Called when the Items collection that is associated with the ItemsControl for this Panel changes. (Inherited from VirtualizingPanel) |
| PageDown | Scrolls content by one page toward the bottom. (Inherited from OrientedVirtualizingPanel) |
| PageLeft | Scrolls content by one page toward the left. (Inherited from OrientedVirtualizingPanel) |
| PageRight | Scrolls content by one page toward the right. (Inherited from OrientedVirtualizingPanel) |
| PageUp | Scrolls content by one page toward the top. (Inherited from OrientedVirtualizingPanel) |
| ReadLocalValue | Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject) |
| ReleasePointerCapture | Releases pointer captures for capture of one specific pointer by this UIElement. (Inherited from UIElement) |
| ReleasePointerCaptures | Releases all pointer captures held by this element. (Inherited from UIElement) |
| RemoveHandler | Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler. (Inherited from UIElement) |
| RemoveInternalChildRange | Removes child elements from the Children collection. (Inherited from VirtualizingPanel) |
| SetBinding | Attaches a binding to a FrameworkElement, using the provided binding object. (Inherited from FrameworkElement) |
| SetHorizontalOffset | Changes the horizontal offset of content within the OrientedVirtualizingPanel viewport. (Inherited from OrientedVirtualizingPanel) |
| SetValue | Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject) |
| SetVerticalOffset | Changes the vertical offset of content within the OrientedVirtualizingPanel viewport. (Inherited from OrientedVirtualizingPanel) |
| SetVirtualizationMode | Sets the VirtualizingStackPanel.VirtualizationMode XAML attached property on the specified target element. |
| TransformToVisual | Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement) |
| UpdateLayout | Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement) |
Attached Properties
The VirtualizingStackPanel class has these attached properties.
| Access type | Description | |
|---|---|---|
| Read/write | Gets or sets a value that sets the virtualization mode of items being virtualized by a parent VirtualizingStackPanel and items set. |
Properties
The VirtualizingStackPanel class has these properties.
| Property | Access type | Description |
|---|---|---|
| Read-only | Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read-only | Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations. (Inherited from UIElement) | |
| Read-only | Gets a value that indicates whether the horizontal snap points for the OrientedVirtualizingPanel are equidistant from each other. (Inherited from OrientedVirtualizingPanel) | |
| Read/write | Gets or sets a value that indicates whether the generated snap points used for panning in the VirtualizingStackPanel are equidistant from each other. | |
| Read-only | Identifies the AreScrollSnapPointsRegular dependency property. | |
| Read-only | Gets a value that indicates whether the vertical snap points for the OrientedVirtualizingPanel are equidistant from each other. (Inherited from OrientedVirtualizingPanel) | |
| Read/write | Gets or sets a Brush that is used to fill the panel. (Inherited from Panel) | |
| Read-only | Gets a Uniform Resource Identifier (URI) that represents the base Uniform Resource Identifier (URI) for an XAML-constructed object at XAML load time. This property is useful for Uniform Resource Identifier (URI) resolution at run time. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible. (Inherited from UIElement) | |
| Read/write | Gets or sets a value that determines how the OrientedVirtualizingPanel measures space for child elements for possible scrolling in the horizontal dimension. Not intended to be set in XAML. (Inherited from OrientedVirtualizingPanel) | |
| Read/write | Gets or sets a value that determines how the OrientedVirtualizingPanel measures space for child elements for possible scrolling in the vertical dimension. Not intended to be set in XAML. (Inherited from OrientedVirtualizingPanel) | |
| Read-only | Gets the collection of child elements of the panel. (Inherited from Panel) | |
| Read/write | Gets or sets the collection of Transition style elements that apply to child content of a Panel subclass. (Inherited from Panel) | |
| Read/write | Gets or sets the RectangleGeometry used to define the outline of the contents of a UIElement. (Inherited from UIElement) | |
| Read/write | Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement) | |
| Read-only | Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement) | |
| Read-only | Gets the CoreDispatcher that this object is associated with. (Inherited from DependencyObject) | |
| Read-only | Gets the vertical size of the panel extent. (Inherited from OrientedVirtualizingPanel) | |
| Read-only | Gets the horizontal size of the panel extent. (Inherited from OrientedVirtualizingPanel) | |
| Read/write | Gets or sets the direction in which text and other UI elements flow within any parent element that controls their layout. This property can be set to either LeftToRight or RightToLeft. Setting FlowDirection to RightToLeft on any element sets the alignment to the right, the reading order to right-to-left and the layout of the control to flow from right to left. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control. (Inherited from FrameworkElement) | |
| Read-only | Gets the horizontal offset of the scrolled content. (Inherited from OrientedVirtualizingPanel) | |
| Read/write | Gets or sets a value that determines whether the DoubleTapped event can originate from that element. (Inherited from UIElement) | |
| Read/write | Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement) | |
| Read/write | Gets or sets a value that determines whether the Holding event can originate from that element. (Inherited from UIElement) | |
| Read-only | Gets a value that indicates whether this Panel is a container for UI items that are generated by an ItemsControl. (Inherited from Panel) | |
| Read/write | Gets or sets a value that determines whether the RightTapped event can originate from that element. (Inherited from UIElement) | |
| Read/write | Gets or sets a value that determines whether the Tapped event can originate from that element. (Inherited from UIElement) | |
| Read-only | Identifies the VirtualizingStackPanel.IsVirtualizing attached property. | |
| Read-only | Gets a value that identifies the ItemContainerGenerator for this VirtualizingPanel. (Inherited from VirtualizingPanel) | |
| Read/write | Gets or sets localization/globalization language information that applies to a FrameworkElement, and also to all child elements of the current FrameworkElement in the object representation and in UI. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. (Inherited from UIElement) | |
| Read/write | Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the degree of the object's opacity. (Inherited from UIElement) | |
| Read/write | Gets or sets a value that describes the horizontal or vertical orientation of stacked content. | |
| Read-only | Identifies the Orientation dependency property. | |
| Read-only | Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement) | |
| Read-only | Gets the set of all captured pointers, represented as Pointer values. (Inherited from UIElement) | |
| Read/write | Gets or sets the perspective projection (3-D effect) to apply when rendering this element. (Inherited from UIElement) | |
| Read-only | Gets the final render size of a UIElement. (Inherited from UIElement) | |
| Read/write | Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement) | |
| Read/write | Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement) | |
| Read/write | Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets a reference to a ScrollViewer that is the scroll host or scroll owner for scrolling behavior of the OrientedVirtualizingPanel. (Inherited from OrientedVirtualizingPanel) | |
| Read/write | Gets or sets an instance Style that is applied for this object during layout and rendering. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the collection of Transition style elements that apply to a UIElement. (Inherited from UIElement) | |
| Read-only | Gets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels. (Inherited from UIElement) | |
| Read/write | Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control. (Inherited from FrameworkElement) | |
| Read-only | Gets the vertical offset of the scrolled content. (Inherited from OrientedVirtualizingPanel) | |
| Read-only | Gets the vertical size of the viewport or content area. (Inherited from OrientedVirtualizingPanel) | |
| Read-only | Gets the horizontal size of the viewport or content area. (Inherited from OrientedVirtualizingPanel) | |
| Read-only | Identifies the VirtualizingStackPanel.VirtualizationMode XAML attached property. | |
| Read/write | Gets or sets the visibility of a UIElement. A UIElement that is not visible is not rendered and does not communicate its desired size to layout. (Inherited from UIElement) | |
| Read/write | Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement) |
Remarks
VirtualizingStackPanel can only be used to display items in an ItemsControl. A primary scenario for VirtualizingStackPanel is that it provides the items panel template behavior for ListView in default templates.
VirtualizingStackPanel attached properties
VirtualizingStackPanel is the host service class for several attached properties that control or report the virtualization mode:
- VirtualizingStackPanel.VirtualizationMode
- VirtualizingStackPanel.IsVirtualizing
VirtualizingStackPanel.VirtualizationMode is an Extensible Application Markup Language (XAML) attached property, and child elements set this property in markup to declare how the item should be virtualized when included as a VirtualizingStackPanel child element.
VirtualizingStackPanel.IsVirtualizing uses the attached property model as a property store, but does not support a XAML usage. Instead, the property serves as a sentinel that any VirtualizingStackPanel child element can check to determine whether that child is currently being represented as virtualized. To find out if an item is being virtualized, call GetIsVirtualizing, passing the item as the input parameter.
Requirements
|
Minimum supported client | Windows 8 [Windows Store apps only] |
|---|---|
|
Minimum supported server | Windows Server 2012 [Windows Store apps only] |
|
Namespace |
|
|
Metadata |
|
See also
- OrientedVirtualizingPanel
- IScrollSnapPointsInfo
- ItemsControl.ItemsPanel
- ItemsPanelTemplate
- Quickstart: Adding ListView and GridView controls
Build date: 3/12/2013
