0 out of 1 rated this helpful - Rate this topic

VirtualizingStackPanel Class

April 12, 2014

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

Namespace:  System.Windows.Controls
Assembly:  System.Windows (in System.Windows.dll)
XMLNS for XAML: Not mapped to an xmlns.
public class VirtualizingStackPanel : VirtualizingPanel, 
	IScrollInfo
<ItemsPanelTemplate>
  <VirtualizingStackPanel .../>
</ItemsPanelTemplate>

The VirtualizingStackPanel type exposes the following members.

  NameDescription
Public methodVirtualizingStackPanelInitializes a new instance of the VirtualizingStackPanel class.
Top
  NameDescription
Public propertyActualHeightGets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyActualWidthGets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyAllowDropGets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations. (Inherited from UIElement.)
Public propertyBackgroundGets or sets a Brush that is used to fill the panel. (Inherited from Panel.)
Public propertyCacheModeGets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
Public propertyCanHorizontallyScrollGets or sets a value that indicates whether a VirtualizingStackPanel can scroll in the horizontal dimension.
Public propertyCanVerticallyScrollGets or sets a value that indicates whether content can scroll in the vertical dimension.
Public propertyChildrenGets the collection of child elements of the panel. (Inherited from Panel.)
Public propertyClipGets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
Public propertyCursorInfrastructure. Gets or sets the cursor image that displays while the pointer is over a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyDataContextGets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.)
Public propertyDesiredSizeGets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.)
Public propertyDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertyExtentHeightGets a value that contains the vertical size of the extent.
Public propertyExtentWidthGets a value that contains the horizontal size of the extent.
Public propertyFlowDirectionGets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.)
Public propertyHeightGets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyHorizontalAlignmentGets 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.)
Public propertyHorizontalOffsetGets a value that contains the horizontal offset of the scrolled content.
Public propertyIsHitTestVisibleGets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.)
Public propertyIsItemsHostGets a value that indicates whether this Panel is a container for UI items that are generated by an ItemsControl. (Inherited from Panel.)
Public propertyItemContainerGeneratorGets a value that identifies the ItemContainerGenerator for this VirtualizingPanel. (Inherited from VirtualizingPanel.)
Public propertyLanguageGets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMarginGets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMaxHeightGets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMaxWidthGets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMinHeightGets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMinWidthGets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyNameGets 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.)
Public propertyOpacityGets or sets the degree of the object's opacity. (Inherited from UIElement.)
Public propertyOpacityMaskGets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.)
Public propertyOrientationGets or sets a value that describes the horizontal or vertical orientation of stacked content.
Public propertyParentGets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.)
Public propertyProjectionGets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.)
Public propertyRenderSizeGets the final render size of a UIElement. (Inherited from UIElement.)
Public propertyRenderTransformGets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.)
Public propertyRenderTransformOriginGets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement.)
Public propertyResourcesGets 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.)
Public propertyScrollOwnerGets or sets a value that identifies the container that controls scrolling behavior in this VirtualizingStackPanel.
Public propertyStyleGets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
Public propertyTagGets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.)
Public propertyTriggersGets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyUseLayoutRoundingGets 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.)
Public propertyUseOptimizedManipulationRoutingGets or sets a value that indicates whether the system should handle input events or whether the FrameworkElement should handle input events. (Inherited from FrameworkElement.)
Public propertyVerticalAlignmentGets 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.)
Public propertyVerticalOffsetGets a value that represents how far down the content is currently scrolled.
Public propertyViewportHeightGets a value that contains the vertical size of the viewport (visible area) of the content.
Public propertyViewportWidthGets a value that contains the horizontal size of the viewport (visible area) of the content.
Public propertyVisibilityGets 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.)
Public propertyWidthGets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.)
Top
  NameDescription
Public attached propertyIsVirtualizingGets a value that indicates whether this VirtualizingStackPanel is virtualizing its child collection.
Public attached propertyVirtualizationModeGets or sets how a panel in an ItemsControl virtualizes its child items.
Top
  NameDescription
Public methodAddHandlerAdds 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.)
Protected methodAddInternalChildAdds the specified UIElement to the Children collection of a VirtualizingPanel element. (Inherited from VirtualizingPanel.)
Public methodArrangePositions 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.)
Protected methodArrangeOverrideArranges the content of a VirtualizingStackPanel element. (Overrides FrameworkElement.ArrangeOverride(Size).)
Protected methodBringIndexIntoViewWhen implemented in a derived class, generates the item at the specified index location and makes it visible. (Inherited from VirtualizingPanel.)
Public methodCaptureMouseSets touch capture to a UIElement. (Inherited from UIElement.)
Public methodCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodFindNameRetrieves an object that has the specified identifier name. (Inherited from FrameworkElement.)
Public methodGetAnimationBaseValueReturns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodGetBindingExpressionRetrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodStatic memberGetIsVirtualizingGets a value that determines whether the VirtualizingStackPanel is virtualizing its content.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Public methodStatic memberGetVirtualizationModeReturns the VirtualizationMode for the specified object.
Protected methodInsertInternalChildAdds the specified UIElement to the collection of a VirtualizingPanel element at the specified index position. (Inherited from VirtualizingPanel.)
Public methodInvalidateArrangeInvalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement.)
Public methodInvalidateMeasureInvalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.)
Public methodLineDownScrolls content downward by one logical unit.
Public methodLineLeftScrolls content to the left by one logical unit.
Public methodLineRightScrolls content to the right by one logical unit.
Public methodLineUpScrolls content upward by one logical unit.
Public methodMakeVisibleScrolls to the specified coordinates and makes that portion of a UIElement visible.
Public methodMeasureUpdates 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.)
Protected methodMeasureOverrideMeasures the child elements of a VirtualizingStackPanel in anticipation of arranging them during the ArrangeOverride pass. (Overrides FrameworkElement.MeasureOverride(Size).)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodMouseWheelDownScrolls content logically downward.
Public methodMouseWheelLeftScrolls content logically to the left.
Public methodMouseWheelRightScrolls content logically to the right.
Public methodMouseWheelUpScrolls content logically upward.
Public methodOnApplyTemplateWhen 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.)
Protected methodOnCleanUpVirtualizedItemCalled when an item that is hosted by the VirtualizingStackPanel is re-virtualized.
Protected methodOnClearChildrenCalled when the collection of child elements is cleared by the base Panel class. (Overrides VirtualizingPanel.OnClearChildren().)
Protected methodOnCreateAutomationPeerWhen implemented in a derived class, returns class-specific AutomationPeer implementations for the Windows Phone automation infrastructure. (Inherited from UIElement.)
Protected methodOnItemsChangedCalled when the Items collection that is associated with the ItemsControl for this Panel changes. (Overrides VirtualizingPanel.OnItemsChanged(Object, ItemsChangedEventArgs).)
Public methodPageDownScrolls content downward by one page.
Public methodPageLeftScrolls content to the left by one page.
Public methodPageRightScrolls content to the right by one page.
Public methodPageUpScrolls content upward by one page.
Public methodReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodReleaseMouseCaptureRemoves touch capture from a UIElement. After this call, typically no object holds touch capture. (Inherited from UIElement.)
Public methodRemoveHandlerRemoves the specified routed event handler from this UIElement. (Inherited from UIElement.)
Protected methodRemoveInternalChildRangeRemoves child elements from the Children collection. (Inherited from VirtualizingPanel.)
Public methodSetBindingAttaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.)
Public methodSetHorizontalOffsetSets the value of the HorizontalOffset property.
Public methodSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodSetVerticalOffsetSets the value of the VerticalOffset property.
Public methodStatic memberSetVirtualizationModeSets the VirtualizationMode on the specified object.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodTransformToVisualReturns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.)
Public methodUpdateLayoutEnsures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.)
Top
  NameDescription
Public eventBindingValidationErrorOccurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.)
Public eventCleanUpVirtualizedItemEventOccurs when an item that is hosted by the VirtualizingStackPanel is re-virtualized.
Public eventDoubleTapOccurs when a DoubleTap gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventGotFocusOccurs when a UIElement receives focus. (Inherited from UIElement.)
Public eventHoldOccurs when a Hold gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventKeyDownOccurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.)
Public eventKeyUpOccurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.)
Public eventLayoutUpdatedOccurs when the layout of the Windows Phone visual tree changes. (Inherited from FrameworkElement.)
Public eventLoadedOccurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.)
Public eventLostFocusOccurs when a UIElement loses focus. (Inherited from UIElement.)
Public eventLostMouseCaptureOccurs when the UIElement loses touch capture. (Inherited from UIElement.)
Public eventManipulationCompletedOccurs when a manipulation and inertia on the UIElement is complete. (Inherited from UIElement.)
Public eventManipulationDeltaOccurs when the input device changes position during a manipulation. (Inherited from UIElement.)
Public eventManipulationStartedOccurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement.)
Public eventMouseEnterOccurs when a screen tap occurs within the bounding area of a UIElement. (Inherited from UIElement.)
Public eventMouseLeaveOccurs when a touch event occurs outside the bounding area of a UIElement. (Inherited from UIElement.)
Public eventMouseLeftButtonDownOccurs when a UIElement is tapped. (Inherited from UIElement.)
Public eventMouseLeftButtonUpOccurs when the finger is lifted off of a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.)
Public eventMouseMoveOccurs when the coordinate position of the finger on the screen while touching a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.)
Public eventMouseWheelInfrastructure. Occurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.)
Public eventSizeChangedOccurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.)
Public eventTapOccurs when a Tap gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventTextInputOccurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.)
Public eventTextInputStartOccurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.)
Public eventTextInputUpdateOccurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.)
Public eventUnloadedOccurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.)
Top
  NameDescription
Public fieldStatic memberIsVirtualizingPropertyA value that indicates whether the VirtualizingStackPanel is using virtualization.
Public fieldStatic memberOrientationPropertyIdentifies the Orientation dependency property.
Public fieldStatic memberVirtualizationModePropertyThe current virtualization mode of the VirtualizingStackPanel (whether it is Recycling or not).
Top

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.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.