ScrollViewer Class
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Represents a scrollable area that can contain other visible elements.
Assembly: System.Windows (in System.Windows.dll)
XMLNS for XAML: Not mapped to an xmlns.
The ScrollViewer type exposes the following members.
| 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 | (Inherited from Control.) |
| BorderBrush | (Inherited from Control.) |
| BorderThickness | (Inherited from Control.) |
| CacheMode | Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.) |
| CharacterSpacing | (Inherited from Control.) |
| Clip | Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.) |
| ComputedHorizontalScrollBarVisibility | Gets a value that indicates whether the horizontal ScrollBar is visible. |
| ComputedVerticalScrollBarVisibility | Gets a value that indicates whether the vertical ScrollBar is visible. |
| Content | Gets or sets the value of the ContentControl dependency property. (Inherited from ContentControl.) |
| ContentTemplate | Gets or sets the data template that is used to display the content of the ContentControl. (Inherited from ContentControl.) |
| 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.) |
 | DefaultStyleKey | (Inherited from Control.) |
| 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 the vertical size of all the content for display in the ScrollViewer. |
| ExtentWidth | Gets the horizontal size of all the content for display in the ScrollViewer. |
| 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.) |
| FontFamily | (Inherited from Control.) |
| FontSize | (Inherited from Control.) |
| FontStretch | (Inherited from Control.) |
| FontStyle | (Inherited from Control.) |
| FontWeight | (Inherited from Control.) |
| Foreground | (Inherited from Control.) |
| 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.) |
| HorizontalContentAlignment | (Inherited from Control.) |
| HorizontalOffset | Gets a value that contains the horizontal offset of the scrolled content. |
| HorizontalScrollBarVisibility | Gets or sets a value that indicates whether a horizontal ScrollBar should be displayed. |
| IsEnabled | (Inherited from Control.) |
| IsHitTestVisible | Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.) |
| IsTabStop | (Inherited from Control.) |
| Language | Gets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.) |
| ManipulationMode | Gets or sets how manipulations are handled for ScrollViewer behavior. |
| 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.) |
| Padding | (Inherited from Control.) |
| 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.) |
| ScrollableHeight | Gets a value that represents the vertical size of the area that can be scrolled; the difference between the height of the extent and the height of the viewport. |
| ScrollableWidth | Gets a value that represents the horizontal size of the area that can be scrolled; the difference between the width of the extent and the width of the viewport. |
| Style | Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.) |
| TabIndex | (Inherited from Control.) |
| TabNavigation | (Inherited from Control.) |
| Tag | Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.) |
| Template | (Inherited from Control.) |
| 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.) |
| VerticalContentAlignment | (Inherited from Control.) |
| VerticalOffset | Gets a value that contains the vertical offset of the scrolled content. |
| VerticalScrollBarVisibility | Gets or sets a value that indicates whether a vertical ScrollBar should be displayed. |
| ViewportHeight | Gets a value that contains the vertical size of the viewable content. |
| ViewportWidth | Gets a value that contains the horizontal size of the viewable 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 | |
|---|---|---|
 | 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.) |
| ApplyTemplate | (Inherited from Control.) |
| 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 Windows Phone layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement.) |
| 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.) |
| Focus | (Inherited from Control.) |
| 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.) |
 | GetHorizontalScrollBarVisibility | Gets the value of the HorizontalScrollBarVisibility dependency property from a specified element. |
| GetManipulationMode | Gets the value of the ManipulationMode attached property, and supports the property's XAML usage. |
| GetTemplateChild | (Inherited from Control.) |
| 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.) |
| GetVerticalScrollBarVisibility | Gets the value of the VerticalScrollBarVisibility dependency property from a specified element. |
| 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.) |
| InvalidateScrollInfo | Called when the value of properties that describe the size and location of the scroll area change. |
| 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 Windows Phone layout. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnApplyTemplate | Builds the visual tree for the ScrollViewer control when a new template is applied. (Overrides FrameworkElement::OnApplyTemplate().) |
| OnContentChanged | Called when the value of the Content property changes. (Inherited from ContentControl.) |
| OnCreateAutomationPeer | When implemented in a derived class, returns class-specific AutomationPeer implementations for the Windows Phone automation infrastructure. (Inherited from UIElement.) |
| OnDoubleTap | (Inherited from Control.) |
| OnDragEnter | (Inherited from Control.) |
| OnDragLeave | (Inherited from Control.) |
| OnDragOver | (Inherited from Control.) |
| OnDrop | (Inherited from Control.) |
| OnGotFocus | (Inherited from Control.) |
| OnHold | (Inherited from Control.) |
| OnKeyDown | (Inherited from Control.) |
| OnKeyUp | (Inherited from Control.) |
| OnLostFocus | (Inherited from Control.) |
| OnLostMouseCapture | (Inherited from Control.) |
| OnManipulationCompleted | (Inherited from Control.) |
| OnManipulationDelta | (Inherited from Control.) |
| OnManipulationStarted | (Inherited from Control.) |
| OnMouseEnter | (Inherited from Control.) |
| OnMouseLeave | (Inherited from Control.) |
| OnMouseLeftButtonDown | (Inherited from Control.) |
| OnMouseLeftButtonUp | (Inherited from Control.) |
| OnMouseMove | (Inherited from Control.) |
| OnMouseRightButtonDown | (Inherited from Control.) |
| OnMouseRightButtonUp | (Inherited from Control.) |
| OnMouseWheel | (Inherited from Control.) |
| OnTap | (Inherited from Control.) |
| OnTextInput | (Inherited from Control.) |
| OnTextInputStart | (Inherited from Control.) |
| OnTextInputUpdate | (Inherited from Control.) |
| 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.) |
| ScrollToHorizontalOffset | Scrolls the content that is within the ScrollViewer to the specified horizontal offset position. |
| ScrollToVerticalOffset | Scrolls the content that is within the ScrollViewer to the specified vertical offset position. |
| SetBinding | Attaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.) |
| SetHorizontalScrollBarVisibility | Sets the value of the HorizontalScrollBarVisibility dependency property to a specified element. |
| SetManipulationMode | Sets the value of the ManipulationMode attached property, and supports the property's XAML usage. |
| SetValue | Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.) |
| SetVerticalScrollBarVisibility | Sets the value of the VerticalScrollBarVisibility dependency property to a specified element. |
| 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.) |
| 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.) |
| IsEnabledChanged | (Inherited from Control.) |
| 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.) |
Top
The ScrollViewer element encapsulates a content element and up to two ScrollBar controls. The extent includes all the content of the ScrollViewer. The visible area of the content is the viewport.
The HorizontalScrollBarVisibility and VerticalScrollBarVisibility properties control the conditions under which the vertical and horizontal ScrollBar controls appear. If they are set to Hidden, you can use ComputedHorizontalScrollBarVisibilityProperty and ComputedVerticalScrollBarVisibilityProperty in code to discover what their actual state is at run time.
Customizing the ScrollViewer Control
To apply the same property settings to multiple ScrollViewer controls, use the Style property. To change the visual structure and visual behavior of a ScrollViewer, copy and modify its default style and template.
Dependency properties for this control might be set by the default style of the control. If a dependency property for a ScrollViewer is set by its default style, the property might change from its default value when the ScrollViewer appears in the application. For more information, see Dependency properties for Windows Phone 8.
 Note: |
|---|
Setting a visual property will only have an effect if that property is both present in ScrollViewer control's default template and is set by using aTemplateBinding. |
Version Notes
Windows Phone
Scrolling performance improvements have been made for the ListBox control in Windows Phone OS 7.1, which affect how some ScrollViewer properties are updated and when events occur. The following table describes the differences in behavior for Windows Phone OS 7.0 and Windows Phone OS 7.1.
Behavior | Windows Phone OS 7.0 app/Windows Phone OS 7.0 device | Windows Phone OS 7.0 or Windows Phone OS 7.1 app/Windows Phone OS 7.1 device |
|---|---|---|
ScrollViewer properties are updated on the UI thread during scrolling. | Properties updated as soon as values change. | Properties updated when the user lifts their finger or when the user drags, pans or flicks ¼ of the screen, in any direction. |
ManipulationDelta events raised on UI thread when dragging inside of a ScrollViewer. | Events are available for handling by elements in the ScrollViewer. | Events are not raised since they are on the input thread. |
If your application depends on the Windows Phone OS 7.0 behavior, you can opt out of the performance improvements by setting the ManipulationMode property on the ScrollViewer associated with the ListBox to Control. The following code example shows how to do this.
<ListBox ItemsSource="{Binding Items}" ScrollViewer.ManipulationMode ="Control" Height="652" Canvas.Top="80">
The following XAML creates a large TextBlock inside a ScrollViewer, along with another copy of the TextBlock for comparison.
<!-- A large TextBlock. --> <TextBlock Canvas.Top="60" Canvas.Left="20" Width="200" TextWrapping="Wrap" Text="I am the very model of a modern Major-General, I've information vegetable, animal, and mineral, I know the kings of England, and I quote the fights historical, From Marathon to Waterloo, in order categorical; I'm very well acquainted, too, with matters mathematical, I understand equations, both the simple and quadratical, About binomial theorem I'm teeming with a lot o' news, With many cheerful facts about the square of the hypotenuse." /> <!-- The same large TextBlock, wrapped in a ScrollViewer. --> <!-- It can be scrolled in either direction, since VerticalScrollBarVisibility --> <!-- has a default value of Visible. --> <ScrollViewer Height="200" Width="150" HorizontalScrollBarVisibility="Auto" Canvas.Top="60" Canvas.Left="240"> <TextBlock Width="200" TextWrapping="Wrap" Text="I am the very model of a modern Major-General, I've information vegetable, animal, and mineral, I know the kings of England, and I quote the fights historical, From Marathon to Waterloo, in order categorical; I'm very well acquainted, too, with matters mathematical, I understand equations, both the simple and quadratical, About binomial theorem I'm teeming with a lot o' news, With many cheerful facts about the square of the hypotenuse." /> </ScrollViewer>
Show: