VirtualizingStackPanel Class
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Arranges and virtualizes content on a single line that is oriented either horizontally or vertically.
System::Object
System.Windows::DependencyObject
System.Windows::UIElement
System.Windows::FrameworkElement
System.Windows.Controls::Panel
System.Windows.Controls::VirtualizingPanel
System.Windows.Controls::VirtualizingStackPanel
System.Windows::DependencyObject
System.Windows::UIElement
System.Windows::FrameworkElement
System.Windows.Controls::Panel
System.Windows.Controls::VirtualizingPanel
System.Windows.Controls::VirtualizingStackPanel
Assembly: System.Windows (in System.Windows.dll)
XMLNS for XAML: Not mapped to an xmlns.
The VirtualizingStackPanel type exposes the following members.
| Name | Description | |
|---|---|---|
 | VirtualizingStackPanel | Initializes a new instance of the VirtualizingStackPanel class. |
| Name | Description | |
|---|---|---|
 | ActualHeight | Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.) |
| ActualWidth | Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.) |
| AllowDrop | 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.) |
| Background | Gets or sets a Brush that is used to fill the panel. (Inherited from Panel.) |
| CacheMode | Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.) |
| CanHorizontallyScroll | Gets or sets a value that indicates whether a VirtualizingStackPanel can scroll in the horizontal dimension. |
| CanVerticallyScroll | Gets or sets a value that indicates whether content can scroll in the vertical dimension. |
| Children | Gets the collection of child elements of the panel. (Inherited from Panel.) |
| Clip | Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.) |
| Cursor | Infrastructure. Gets or sets the cursor image that displays while the pointer is over a FrameworkElement. (Inherited from FrameworkElement.) |
| DataContext | Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.) |
| DesiredSize | Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.) |
| Dispatcher | Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.) |
| ExtentHeight | Gets a value that contains the vertical size of the extent. |
| ExtentWidth | Gets a value that contains the horizontal size of the extent. |
| FlowDirection | Gets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.) |
| Height | Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.) |
| HorizontalAlignment | 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.) |
| HorizontalOffset | Gets a value that contains the horizontal offset of the scrolled content. |
| IsHitTestVisible | Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.) |
| IsItemsHost | Gets a value that indicates whether this Panel is a container for UI items that are generated by an ItemsControl. (Inherited from Panel.) |
| ItemContainerGenerator | Gets a value that identifies the ItemContainerGenerator for this VirtualizingPanel. (Inherited from VirtualizingPanel.) |
| Language | Gets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.) |
| Margin | Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.) |
| MaxHeight | Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
| MaxWidth | Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
| MinHeight | Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
| MinWidth | Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
| Name | 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.) |
| Opacity | Gets or sets the degree of the object's opacity. (Inherited from UIElement.) |
| OpacityMask | Gets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.) |
| Orientation | Gets or sets a value that describes the horizontal or vertical orientation of stacked content. |
| Parent | Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.) |
| Projection | Gets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.) |
| RenderSize | Gets the final render size of a UIElement. (Inherited from UIElement.) |
| RenderTransform | Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.) |
| RenderTransformOrigin | Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement.) |
| Resources | 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.) |
| ScrollOwner | Gets or sets a value that identifies the container that controls scrolling behavior in this VirtualizingStackPanel. |
| Style | Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.) |
| Tag | Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.) |
| Triggers | Gets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.) |
| UseLayoutRounding | 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.) |
| UseOptimizedManipulationRouting | Gets or sets a value that indicates whether the system should handle input events or whether the FrameworkElement should handle input events. (Inherited from FrameworkElement.) |
| VerticalAlignment | 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.) |
| VerticalOffset | Gets a value that represents how far down the content is currently scrolled. |
| ViewportHeight | Gets a value that contains the vertical size of the viewport (visible area) of the content. |
| ViewportWidth | Gets a value that contains the horizontal size of the viewport (visible area) of the content. |
| Visibility | Gets or sets the visibility of a UIElement. A UIElement that is not visible does not render and does not communicate its desired size to layout. (Inherited from UIElement.) |
| Width | Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.) |
| Name | Description | |
|---|---|---|
| IsVirtualizing | Gets a value that indicates whether this VirtualizingStackPanel is virtualizing its child collection. |
| VirtualizationMode | Gets or sets how a panel in an ItemsControl virtualizes its child items. |
| Name | 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 for routed event that had already been marked as handled by another element along the event route. (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 | Arranges the content of a VirtualizingStackPanel element. (Overrides FrameworkElement::ArrangeOverride(Size).) |
| BringIndexIntoView | When implemented in a derived class, generates the item at the specified index location and makes it visible. (Inherited from VirtualizingPanel.) |
| CaptureMouse | Sets touch capture to a UIElement. (Inherited from UIElement.) |
| CheckAccess | Determines whether the calling thread has access to this object. (Inherited from DependencyObject.) |
| ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject.) |
| Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| FindName | Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement.) |
| GetAnimationBaseValue | Returns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.) |
| GetBindingExpression | Retrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
 | GetIsVirtualizing | Gets a value that determines whether the VirtualizingStackPanel is virtualizing its content. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetValue | Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.) |
| GetVirtualizationMode | Returns the VirtualizationMode for the specified object. |
| 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 downward by one logical unit. |
| LineLeft | Scrolls content to the left by one logical unit. |
| LineRight | Scrolls content to the right by one logical unit. |
| LineUp | Scrolls content upward by one logical unit. |
| MakeVisible | Scrolls to the specified coordinates and makes that portion of a UIElement visible. |
| 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 | Measures the child elements of a VirtualizingStackPanel in anticipation of arranging them during the ArrangeOverride pass. (Overrides FrameworkElement::MeasureOverride(Size).) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MouseWheelDown | Scrolls content logically downward. |
| MouseWheelLeft | Scrolls content logically to the left. |
| MouseWheelRight | Scrolls content logically to the right. |
| MouseWheelUp | Scrolls content logically upward. |
| OnApplyTemplate | When overridden in a derived class, is 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 an application. For more information, see Remarks. (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. (Overrides VirtualizingPanel::OnClearChildren().) |
| OnCreateAutomationPeer | When implemented in a derived class, returns class-specific AutomationPeer implementations for the Windows Phone automation infrastructure. (Inherited from UIElement.) |
| OnItemsChanged | Called when the Items collection that is associated with the ItemsControl for this Panel changes. (Overrides VirtualizingPanel::OnItemsChanged(Object, ItemsChangedEventArgs).) |
| PageDown | Scrolls content downward by one page. |
| PageLeft | Scrolls content to the left by one page. |
| PageRight | Scrolls content to the right by one page. |
| PageUp | Scrolls content upward by one page. |
| ReadLocalValue | Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.) |
| ReleaseMouseCapture | Removes touch capture from a UIElement. After this call, typically no object holds touch capture. (Inherited from UIElement.) |
| RemoveHandler | Removes the specified routed event handler from this UIElement. (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, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.) |
| SetHorizontalOffset | Sets the value of the HorizontalOffset property. |
| SetValue | Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.) |
| SetVerticalOffset | Sets the value of the VerticalOffset property. |
| SetVirtualizationMode | Sets the VirtualizationMode on the specified object. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| 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.) |
| Name | Description | |
|---|---|---|
 | BindingValidationError | Occurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.) |
| CleanUpVirtualizedItemEvent | Occurs when an item that is hosted by the VirtualizingStackPanel is re-virtualized. |
| DoubleTap | Occurs when a DoubleTap gesture is committed while over this UIElement. (Inherited from UIElement.) |
| GotFocus | Occurs when a UIElement receives focus. (Inherited from UIElement.) |
| Hold | Occurs when a Hold gesture is committed while over this UIElement. (Inherited from UIElement.) |
| 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 Windows Phone visual tree changes. (Inherited from FrameworkElement.) |
| Loaded | Occurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.) |
| LostFocus | Occurs when a UIElement loses focus. (Inherited from UIElement.) |
| LostMouseCapture | Occurs when the UIElement loses touch capture. (Inherited from UIElement.) |
| ManipulationCompleted | Occurs when a manipulation and inertia on the UIElement is complete. (Inherited from UIElement.) |
| ManipulationDelta | Occurs when the input device changes position during a manipulation. (Inherited from UIElement.) |
| ManipulationStarted | Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement.) |
| MouseEnter | Occurs when a screen tap occurs within the bounding area of a UIElement. (Inherited from UIElement.) |
| MouseLeave | Occurs when a touch event occurs outside the bounding area of a UIElement. (Inherited from UIElement.) |
| MouseLeftButtonDown | Occurs when a UIElement is tapped. (Inherited from UIElement.) |
| MouseLeftButtonUp | Occurs when the finger is lifted off of a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.) |
| MouseMove | Occurs when the coordinate position of the finger on the screen while touching a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.) |
| MouseWheel | Infrastructure. Occurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.) |
| SizeChanged | Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.) |
| Tap | Occurs when a Tap gesture is committed while over this UIElement. (Inherited from UIElement.) |
| TextInput | Occurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.) |
| TextInputStart | Occurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.) |
| TextInputUpdate | Occurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.) |
| Unloaded | Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.) |
| Name | Description | |
|---|---|---|
 | IsVirtualizingProperty | A value that indicates whether the VirtualizingStackPanel is using virtualization. |
| OrientationProperty | Identifies the Orientation dependency property. |
| VirtualizationModeProperty | The current virtualization mode of the VirtualizingStackPanel (whether it is Recycling or not). |
The standard layout system creates item containers and computes layout for each item associated with a list control. Generating many UI elements when only a few elements might be on the screen can adversely affect the performance of your application. Virtualization refers to a technique by which a subset of UI elements are generated from a larger number of data items based on which items are visible on-screen. The VirtualizingStackPanel calculates the number of visible items and works with the ItemContainerGenerator from an ItemsControl (such as ListBox) to create UI elements only for visible items.
Virtualization in a StackPanel only occurs when the items control contained in the panel creates its own item containers. You can ensure this happens by using data binding.
VirtualizingStackPanel is the default items host for the ListBox element.
If used in XAML, the VirtualizingStackPanel object element must be contained within an ItemsPanelTemplate.
The VirtualizingStackPanel::IsVirtualizing attached property is not settable in Windows Phone. Instead, virtualizing behavior is set based on whether the container is scroll-enabled, and the size of the data set.
When you set a RenderTransform as a child of the VirtualizingStackPanel, it is returned as a CompositeTransform regardless of the type of transform that is actually applied.
Show: