ScrollViewer Class

July 28, 2014

Represents a scrollable area that can contain other visible elements.

Namespace:  System.Windows.Controls
Assembly:  System.Windows (in System.Windows.dll)
XMLNS for XAML: Not mapped to an xmlns.

[TemplateVisualStateAttribute(Name = "CompressionLeft", GroupName = "HorizontalCompressionStates")]
[TemplateVisualStateAttribute(Name = "NotScrolling", GroupName = "ScrollStates")]
[TemplateVisualStateAttribute(Name = "CompressionBottom", GroupName = "VerticalCompressionStates")]
[TemplatePartAttribute(Name = "HorizontalScrollBar", Type = typeof(ScrollBar))]
[TemplatePartAttribute(Name = "VerticalScrollBar", Type = typeof(ScrollBar))]
[TemplateVisualStateAttribute(Name = "Scrolling", GroupName = "ScrollStates")]
[TemplatePartAttribute(Name = "ScrollContentPresenter", Type = typeof(ScrollContentPresenter))]
[TemplateVisualStateAttribute(Name = "NoHorizontalCompression", GroupName = "HorizontalCompressionStates")]
[TemplateVisualStateAttribute(Name = "CompressionRight", GroupName = "HorizontalCompressionStates")]
[TemplateVisualStateAttribute(Name = "NoVerticalCompression", GroupName = "VerticalCompressionStates")]
[TemplateVisualStateAttribute(Name = "CompressionTop", GroupName = "VerticalCompressionStates")]
public sealed class ScrollViewer : ContentControl
<ScrollViewer .../>
-or-
<ScrollViewer ...>
content
</ScrollViewer>

The ScrollViewer type exposes the following members.

  NameDescription
Public methodScrollViewerInitializes a new instance of the ScrollViewer 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 propertyBackground (Inherited from Control.)
Public propertyBorderBrush (Inherited from Control.)
Public propertyBorderThickness (Inherited from Control.)
Public propertyCacheModeGets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
Public propertyCharacterSpacing (Inherited from Control.)
Public propertyClipGets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
Public propertyComputedHorizontalScrollBarVisibilityGets a value that indicates whether the horizontal ScrollBar is visible.
Public propertyComputedVerticalScrollBarVisibilityGets a value that indicates whether the vertical ScrollBar is visible.
Public propertyContentGets or sets the value of the ContentControl dependency property. (Inherited from ContentControl.)
Public propertyContentTemplateGets or sets the data template that is used to display the content of the ContentControl. (Inherited from ContentControl.)
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.)
Protected propertyDefaultStyleKey (Inherited from Control.)
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 the vertical size of all the content for display in the ScrollViewer.
Public propertyExtentWidthGets the horizontal size of all the content for display in the ScrollViewer.
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 propertyFontFamily (Inherited from Control.)
Public propertyFontSize (Inherited from Control.)
Public propertyFontStretch (Inherited from Control.)
Public propertyFontStyle (Inherited from Control.)
Public propertyFontWeight (Inherited from Control.)
Public propertyForeground (Inherited from Control.)
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 propertyHorizontalContentAlignment (Inherited from Control.)
Public propertyHorizontalOffsetGets a value that contains the horizontal offset of the scrolled content.
Public propertyHorizontalScrollBarVisibilityGets or sets a value that indicates whether a horizontal ScrollBar should be displayed.
Public propertyIsEnabled (Inherited from Control.)
Public propertyIsHitTestVisibleGets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.)
Public propertyIsTabStop (Inherited from Control.)
Public propertyLanguageGets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyManipulationModeGets or sets how manipulations are handled for ScrollViewer behavior.
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 propertyPadding (Inherited from Control.)
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 propertyScrollableHeightGets 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.
Public propertyScrollableWidthGets 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.
Public propertyStyleGets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
Public propertyTabIndex (Inherited from Control.)
Public propertyTabNavigation (Inherited from Control.)
Public propertyTagGets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.)
Public propertyTemplate (Inherited from Control.)
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 propertyVerticalContentAlignment (Inherited from Control.)
Public propertyVerticalOffsetGets a value that contains the vertical offset of the scrolled content.
Public propertyVerticalScrollBarVisibilityGets or sets a value that indicates whether a vertical ScrollBar should be displayed.
Public propertyViewportHeightGets a value that contains the vertical size of the viewable content.
Public propertyViewportWidthGets a value that contains the horizontal size of the viewable 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 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.)
Public methodApplyTemplate (Inherited from Control.)
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 methodArrangeOverrideProvides 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.)
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 methodFocus (Inherited from Control.)
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 memberGetHorizontalScrollBarVisibilityGets the value of the HorizontalScrollBarVisibility dependency property from a specified element.
Public methodStatic memberGetManipulationModeGets the value of the ManipulationMode attached property, and supports the property's XAML usage.
Protected methodGetTemplateChild (Inherited from Control.)
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 memberGetVerticalScrollBarVisibilityGets the value of the VerticalScrollBarVisibility dependency property from a specified element.
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 methodInvalidateScrollInfoCalled when the value of properties that describe the size and location of the scroll area change.
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 methodMeasureOverrideProvides 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.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodOnApplyTemplateBuilds the visual tree for the ScrollViewer control when a new template is applied. (Overrides FrameworkElement.OnApplyTemplate().)
Protected methodOnContentChangedCalled when the value of the Content property changes. (Inherited from ContentControl.)
Protected methodOnCreateAutomationPeerWhen implemented in a derived class, returns class-specific AutomationPeer implementations for the Windows Phone automation infrastructure. (Inherited from UIElement.)
Protected methodOnDoubleTap (Inherited from Control.)
Protected methodOnDragEnter (Inherited from Control.)
Protected methodOnDragLeave (Inherited from Control.)
Protected methodOnDragOver (Inherited from Control.)
Protected methodOnDrop (Inherited from Control.)
Protected methodOnGotFocus (Inherited from Control.)
Protected methodOnHold (Inherited from Control.)
Protected methodOnKeyDown (Inherited from Control.)
Protected methodOnKeyUp (Inherited from Control.)
Protected methodOnLostFocus (Inherited from Control.)
Protected methodOnLostMouseCapture (Inherited from Control.)
Protected methodOnManipulationCompleted (Inherited from Control.)
Protected methodOnManipulationDelta (Inherited from Control.)
Protected methodOnManipulationStarted (Inherited from Control.)
Protected methodOnMouseEnter (Inherited from Control.)
Protected methodOnMouseLeave (Inherited from Control.)
Protected methodOnMouseLeftButtonDown (Inherited from Control.)
Protected methodOnMouseLeftButtonUp (Inherited from Control.)
Protected methodOnMouseMove (Inherited from Control.)
Protected methodOnMouseRightButtonDown (Inherited from Control.)
Protected methodOnMouseRightButtonUp (Inherited from Control.)
Protected methodOnMouseWheel (Inherited from Control.)
Protected methodOnTap (Inherited from Control.)
Protected methodOnTextInput (Inherited from Control.)
Protected methodOnTextInputStart (Inherited from Control.)
Protected methodOnTextInputUpdate (Inherited from Control.)
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.)
Public methodScrollToHorizontalOffsetScrolls the content that is within the ScrollViewer to the specified horizontal offset position.
Public methodScrollToVerticalOffsetScrolls the content that is within the ScrollViewer to the specified vertical offset position.
Public methodSetBindingAttaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.)
Public methodStatic memberSetHorizontalScrollBarVisibilitySets the value of the HorizontalScrollBarVisibility dependency property to a specified element.
Public methodStatic memberSetManipulationModeSets the value of the ManipulationMode attached property, and supports the property's XAML usage.
Public methodSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodStatic memberSetVerticalScrollBarVisibilitySets the value of the VerticalScrollBarVisibility dependency property to a specified element.
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 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 eventIsEnabledChanged (Inherited from Control.)
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 memberComputedHorizontalScrollBarVisibilityPropertyIdentifies the ComputedHorizontalScrollBarVisibility dependency property.
Public fieldStatic memberComputedVerticalScrollBarVisibilityPropertyIdentifies the ComputedVerticalScrollBarVisibility dependency property.
Public fieldStatic memberExtentHeightPropertyIdentifier for the ExtentHeight dependency property.
Public fieldStatic memberExtentWidthPropertyIdentifier for the ExtentWidth dependency property.
Public fieldStatic memberHorizontalOffsetPropertyIdentifies the HorizontalOffset dependency property.
Public fieldStatic memberHorizontalScrollBarVisibilityPropertyIdentifies the HorizontalScrollBarVisibility dependency property.
Public fieldStatic memberManipulationModePropertyIdentifies the ManipulationMode dependency property.
Public fieldStatic memberScrollableHeightPropertyIdentifies the ScrollableHeight dependency property.
Public fieldStatic memberScrollableWidthPropertyIdentifies the ScrollableWidth dependency property.
Public fieldStatic memberVerticalOffsetPropertyIdentifies the VerticalOffset dependency property.
Public fieldStatic memberVerticalScrollBarVisibilityPropertyIdentifies the VerticalScrollBarVisibility dependency property.
Public fieldStatic memberViewportHeightPropertyIdentifies the ViewportHeight dependency property.
Public fieldStatic memberViewportWidthPropertyIdentifies the ViewportWidth dependency property.
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.

NoteNote:

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>


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.

Show:
© 2014 Microsoft