ScrollViewer class (Windows)

3 out of 3 rated this helpful - Rate this topic

Represents a scrollable area that can contain other visible elements.

Inheritance

Object
DependencyObject
UIElement
FrameworkElement
Control
ContentControl
ScrollViewer

Syntax


public sealed class ScrollViewer : ContentControl

XAML Object Element Usage


<ScrollViewer .../>
-or-
<ScrollViewer ...>
content
</ScrollViewer>

Attributes

ActivatableAttribute(NTDDI_WIN8)
MarshalingBehaviorAttribute(Agile)
StaticAttribute(Windows.UI.Xaml.Controls.IScrollViewerStatics, NTDDI_WIN8)
ThreadingAttribute(Both)
VersionAttribute(NTDDI_WIN8)
WebHostHiddenAttribute()

Members

The ScrollViewer class has these types of members:

Constructors
Events
Methods
Properties

Constructors

The ScrollViewer class has these constructors.

Constructor	Description
ScrollViewer	Initializes a new instance of the ScrollViewer class.

Events

The ScrollViewer class has these events.

Event	Description
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)
IsEnabledChanged	Occurs when the IsEnabled property changes. (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 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)
ViewChanged	Occurs when manipulations that affect the view raise an underlying event.

Methods

The ScrollViewer 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)
ApplyTemplate	Loads the relevant control template so that its parts can be referenced. (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 layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement)
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)
Focus	Attempts to set the focus on the control. (Inherited from Control)
GetAnimationBaseValue	Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetBringIntoViewOnFocusChange	Gets the value of the BringIntoViewOnFocusChange dependency property / ScrollViewer.BringIntoViewOnFocusChange XAML attached property from a specified element.
GetHorizontalScrollBarVisibility	Gets the value of the HorizontalScrollBarVisibility dependency property / ScrollViewer.HorizontalScrollBarVisibility XAML attached property from a specified element.
GetHorizontalScrollMode	Gets the value of the HorizontalScrollMode dependency property / ScrollViewer.HorizontalScrollMode XAML attached property from a specified element.
GetIsDeferredScrollingEnabled	Gets the value of the IsDeferredScrollingEnabled dependency property / ScrollViewer.IsDeferredScrollingInertiaEnabled XAML attached property from a specified element.
GetIsHorizontalRailEnabled	Gets the value of the IsHorizontalRailEnabled dependency property / ScrollViewer.IsHorizontalRailEnabled XAML attached property from a specified element.
GetIsHorizontalScrollChainingEnabled	Gets the value of the IsHorizontalScrollChainingEnabled dependency property / ScrollViewer.IsHorizontalScrollChainingEnabled XAML attached property from a specified element.
GetIsScrollInertiaEnabled	Gets the value of the IsScrollInertiaEnabled dependency property / ScrollViewer.IsScrollInertiaEnabled XAML attached property from a specified element.
GetIsVerticalRailEnabled	Gets the value of the IsVerticalRailEnabled dependency property / ScrollViewer.IsVerticalRailEnabled XAML attached property from a specified element.
GetIsVerticalScrollChainingEnabled	Gets the value of the IsVerticalScrollChainingEnabled dependency property / ScrollViewer.IsVerticalScrollChainingEnabled XAML attached property from a specified element.
GetIsZoomChainingEnabled	Gets the value of the IsZoomChainingEnabled dependency property / ScrollViewer.IsZoomChainingEnabled XAML attached property from a specified element.
GetIsZoomInertiaEnabled	Gets the value of the IsZoomInertiaEnabled dependency property / ScrollViewer.IsZoomInertiaEnabled XAML attached property from a specified element.
GetTemplateChild	Retrieves the named element in the instantiated ControlTemplate visual tree. (Inherited from Control)
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 / ScrollViewer.VerticalScrollBarVisibility XAML attached property from a specified element.
GetVerticalScrollMode	Gets the value of the VerticalScrollMode dependency property / ScrollViewer.VerticalScrollMode XAML attached property from a specified element.
GetZoomMode	Gets the value of the ZoomMode dependency property / ScrollViewer.ZoomMode XAML attached 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 the layout cycle. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement)
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)
OnContentChanged	Invoked when the value of the Content property changes. (Inherited from ContentControl)
OnContentTemplateChanged	Invoked when the value of the ContentTemplate property changes. (Inherited from ContentControl)
OnContentTemplateSelectorChanged	Invoked when the value of the ContentTemplateSelector property changes. (Inherited from ContentControl)
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)
OnDoubleTapped	Called before the DoubleTapped event occurs. (Inherited from Control)
OnDragEnter	Called before the DragEnter event occurs. (Inherited from Control)
OnDragLeave	Called before the DragLeave event occurs. (Inherited from Control)
OnDragOver	Called before the DragOver event occurs. (Inherited from Control)
OnDrop	Called before the Drop event occurs. (Inherited from Control)
OnGotFocus	Called before the GotFocus event occurs. (Inherited from Control)
OnHolding	Called before the Holding event occurs. (Inherited from Control)
OnKeyDown	Called before the KeyDown event occurs. (Inherited from Control)
OnKeyUp	Called before the KeyUp event occurs. (Inherited from Control)
OnLostFocus	Called before the LostFocus event occurs. (Inherited from Control)
OnManipulationCompleted	Called before the ManipulationCompleted event occurs. (Inherited from Control)
OnManipulationDelta	Called before the ManipulationDelta event occurs. (Inherited from Control)
OnManipulationInertiaStarting	Called before the ManipulationInertiaStarting event occurs. (Inherited from Control)
OnManipulationStarted	Called before the ManipulationStarted event occurs. (Inherited from Control)
OnManipulationStarting	Called before the ManipulationStarting event occurs. (Inherited from Control)
OnPointerCanceled	Called before the PointerCanceled event occurs. (Inherited from Control)
OnPointerCaptureLost	Called before the PointerCaptureLost event occurs. (Inherited from Control)
OnPointerEntered	Called before the PointerEntered event occurs. (Inherited from Control)
OnPointerExited	Called before the PointerExited event occurs. (Inherited from Control)
OnPointerMoved	Called before the PointerMoved event occurs. (Inherited from Control)
OnPointerPressed	Called before the PointerPressed event occurs. (Inherited from Control)
OnPointerReleased	Called before the PointerReleased event occurs. (Inherited from Control)
OnPointerWheelChanged	Called before the PointerWheelChanged event occurs. (Inherited from Control)
OnRightTapped	Called before the RightTapped event occurs. (Inherited from Control)
OnTapped	Called before the Tapped event occurs. (Inherited from Control)
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)
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. (Inherited from FrameworkElement)
SetBringIntoViewOnFocusChange	Sets the value of the BringIntoViewOnFocusChange dependency property / ScrollViewer.BringIntoViewOnFocusChange XAML attached property on a specified element.
SetHorizontalScrollBarVisibility	Sets the value of the HorizontalScrollBarVisibility dependency property / ScrollViewer.HorizontalScrollBarVisibility XAML attached property on a specified element.
SetHorizontalScrollMode	Sets the value of the HorizontalScrollMode dependency property / ScrollViewer.HorizontalScrollMode XAML attached property on a specified element.
SetIsDeferredScrollingEnabled	Sets the value of the IsDeferredScrollingEnabled dependency property / ScrollViewer.IsDeferredScrollingEnabled XAML attached property on a specified element.
SetIsHorizontalRailEnabled	Sets the value of the IsHorizontalRailEnabled dependency property / ScrollViewer.IsHorizontalRailEnabled XAML attached property on a specified element.
SetIsHorizontalScrollChainingEnabled	Sets the value of the IsHorizontalScrollChainingEnabled dependency property / ScrollViewer.IsHorizontalScrollChainingEnabled XAML attached property on a specified element.
SetIsScrollInertiaEnabled	Sets the value of the IsScrollInertiaEnabled dependency property / ScrollViewer.IsScrollInertiaEnabled XAML attached property on a specified element.
SetIsVerticalRailEnabled	Sets the value of the IsVerticalRailEnabled dependency property / ScrollViewer.IsVerticalRailEnabled XAML attached property on a specified element.
SetIsVerticalScrollChainingEnabled	Sets the value of the IsVerticalScrollChainingEnabled dependency property / ScrollViewer.IsVerticalScrollChainingEnabled XAML attached property on a specified element.
SetIsZoomChainingEnabled	Sets the value of the IsZoomChainingEnabled dependency property / ScrollViewer.IsZoomChainingEnabled XAML attached property on a specified element.
SetIsZoomInertiaEnabled	Sets the value of the IsZoomInertiaEnabled dependency property / ScrollViewer.IsZoomInertiaEnabled XAML attached property on a specified element.
SetValue	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
SetVerticalScrollBarVisibility	Sets the value of the VerticalScrollBarVisibility dependency property / ScrollViewer.VerticalScrollBarVisibility XAML attached property on a specified element.
SetVerticalScrollMode	Sets the value of the VerticalScrollMode dependency property / ScrollViewer.VerticalScrollMode XAML attached property on a specified element.
SetZoomMode	Sets the value of the ZoomMode dependency property / ScrollViewer.ZoomMode XAML attached property on a specified 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)
ZoomToFactor	Sets the effective value of ZoomFactor.

Properties

The ScrollViewer class has these properties.

Property	Access type	Description
ActualHeight	Read-only	Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement)
ActualWidth	Read-only	Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement)
AllowDrop	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)
Background	Read/write	Gets or sets a brush that provides the background of the control. (Inherited from Control)
BaseUri	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)
BorderBrush	Read/write	Gets or sets a brush that describes the border background of a control. (Inherited from Control)
BorderThickness	Read/write	Gets or sets the border thickness of a control. (Inherited from Control)
BringIntoViewOnFocusChange	Read/write	Gets or sets a value that determines whether the ScrollViewer uses a bring-into-view scroll behavior when an item in the view gets focus.
BringIntoViewOnFocusChangeProperty	Read-only	Identifies the BringIntoViewOnFocusChange dependency property.
CacheMode	Read/write	Gets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible. (Inherited from UIElement)
CharacterSpacing	Read/write	Gets or sets the uniform spacing between characters, in units of 1/1000 of an em. (Inherited from Control)
Clip	Read/write	Gets or sets the RectangleGeometry used to define the outline of the contents of a UIElement. (Inherited from UIElement)
ComputedHorizontalScrollBarVisibility	Read-only	Gets a value that indicates whether the horizontal ScrollBar is visible.
ComputedHorizontalScrollBarVisibilityProperty	Read-only	Identifies the ComputedHorizontalScrollBarVisibility dependency property.
ComputedVerticalScrollBarVisibility	Read-only	Gets a value that indicates whether the vertical ScrollBar is visible.
ComputedVerticalScrollBarVisibilityProperty	Read-only	Identifies the ComputedVerticalScrollBarVisibility dependency property.
Content	Read/write	Gets or sets the content of a ContentControl. (Inherited from ContentControl)
ContentTemplate	Read/write	Gets or sets the data template that is used to display the content of the ContentControl. (Inherited from ContentControl)
ContentTemplateSelector	Read/write	Gets or sets a selection object that changes the DataTemplate to apply for content, based on processing information about the content item or its container at run time. (Inherited from ContentControl)
ContentTransitions	Read/write	Gets or sets the collection of Transition style elements that apply to the content of a ContentControl. (Inherited from ContentControl)
DataContext	Read/write	Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement)
DefaultStyleKey	Read/write	Gets or sets the key that references the default style for the control. (Inherited from Control)
DesiredSize	Read-only	Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement)
Dispatcher	Read-only	Gets the CoreDispatcher that this object is associated with. (Inherited from DependencyObject)
ExtentHeight	Read-only	Gets the vertical size of all the scrollable content in the ScrollViewer.
ExtentHeightProperty	Read-only	Identifier for the ExtentHeight dependency property.
ExtentWidth	Read-only	Gets the horizontal size of all the scrollable content in the ScrollViewer.
ExtentWidthProperty	Read-only	Identifier for the ExtentWidth dependency property.
FlowDirection	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)
FocusState	Read-only	Gets a value that specifies whether this control has focus, and the mode by which focus was obtained. (Inherited from Control)
FontFamily	Read/write	Gets or sets the font used to display text in the control. (Inherited from Control)
FontSize	Read/write	Gets or sets the size of the text in this control. (Inherited from Control)
FontStretch	Read/write	Gets or sets the degree to which a font is condensed or expanded on the screen. (Inherited from Control)
FontStyle	Read/write	Gets or sets the style in which the text is rendered. (Inherited from Control)
FontWeight	Read/write	Gets or sets the thickness of the specified font. (Inherited from Control)
Foreground	Read/write	Gets or sets a brush that describes the foreground color. (Inherited from Control)
Height	Read/write	Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement)
HorizontalAlignment	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)
HorizontalContentAlignment	Read/write	Gets or sets the horizontal alignment of the control's content. (Inherited from Control)
HorizontalOffset	Read-only	Gets the distance the content has been scrolled horizontally.
HorizontalOffsetProperty	Read-only	Identifies the HorizontalOffset dependency property.
HorizontalScrollBarVisibility	Read/write	Gets or sets a value that indicates whether a horizontal ScrollBar should be displayed.
HorizontalScrollBarVisibilityProperty	Read-only	Identifies the HorizontalScrollBarVisibility dependency property.
HorizontalScrollMode	Read/write	Gets or sets a value that determines how manipulation input influences scrolling behavior on the horizontal axis.
HorizontalScrollModeProperty	Read-only	Identifies the HorizontalScrollMode dependency property.
HorizontalSnapPointsAlignment	Read/write	Gets or sets a value that indicates how the existing snap points are horizontally aligned versus the initial viewport.
HorizontalSnapPointsAlignmentProperty	Read-only	Identifies the HorizontalSnapPointsAlignment dependency property.
HorizontalSnapPointsType	Read/write	Gets or sets a value that declares how manipulation behavior reacts to the snap points along the horizontal axis.
HorizontalSnapPointsTypeProperty	Read-only	Identifies the HorizontalSnapPointsType dependency property.
IsDeferredScrollingEnabled	Read/write	Gets or sets a value that determines the deferred scrolling behavior for a ScrollViewer.
IsDeferredScrollingEnabledProperty	Read-only	Identifies the IsDeferredScrollingEnabled dependency property.
IsDoubleTapEnabled	Read/write	Gets or sets a value that determines whether the DoubleTapped event can originate from that element. (Inherited from UIElement)
IsEnabled	Read/write	Gets or sets a value indicating whether the user can interact with the control. (Inherited from Control)
IsHitTestVisible	Read/write	Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement)
IsHoldingEnabled	Read/write	Gets or sets a value that determines whether the Holding event can originate from that element. (Inherited from UIElement)
IsHorizontalRailEnabled	Read/write	Gets or sets a value that indicates whether the scroll rail is enabled for the horizontal axis.
IsHorizontalRailEnabledProperty	Read-only	Identifies the IsHorizontalRailEnabled dependency property.
IsHorizontalScrollChainingEnabled	Read/write	Gets or sets a value that indicates whether scroll chaining is enabled from this child to its parent, for the horizontal axis.
IsHorizontalScrollChainingEnabledProperty	Read-only	Identifies the IsHorizontalScrollChainingEnabled dependency property.
IsRightTapEnabled	Read/write	Gets or sets a value that determines whether the RightTapped event can originate from that element. (Inherited from UIElement)
IsScrollInertiaEnabled	Read/write	Gets or sets a value that indicates whether scroll actions should include inertia in their behavior and value.
IsScrollInertiaEnabledProperty	Read-only	Identifies the IsScrollInertiaEnabled dependency property.
IsTabStop	Read/write	Gets or sets a value that indicates whether a control is included in tab navigation. (Inherited from Control)
IsTapEnabled	Read/write	Gets or sets a value that determines whether the Tapped event can originate from that element. (Inherited from UIElement)
IsVerticalRailEnabled	Read/write	Gets or sets a value that indicates whether the scroll rail is enabled for the vertical axis.
IsVerticalRailEnabledProperty	Read-only	Identifies the IsVerticalRailEnabled dependency property.
IsVerticalScrollChainingEnabled	Read/write	Gets or sets a value that indicates whether scroll chaining is enabled from this child to its parent, for the vertical axis.
IsVerticalScrollChainingEnabledProperty	Read-only	Identifies the IsVerticalScrollChainingEnabled dependency property.
IsZoomChainingEnabled	Read/write	Gets or sets a value that indicates whether zoom chaining is enabled from this child to its parent.
IsZoomChainingEnabledProperty	Read-only	Identifies the IsZoomChainingEnabled dependency property.
IsZoomInertiaEnabled	Read/write	Gets or sets a value that indicates whether zoom actions should include inertia in their behavior and value.
IsZoomInertiaEnabledProperty	Read-only	Identifies the IsZoomInertiaEnabled dependency property.
Language	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)
ManipulationMode	Read/write	Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. (Inherited from UIElement)
Margin	Read/write	Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement)
MaxHeight	Read/write	Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement)
MaxWidth	Read/write	Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement)
MaxZoomFactor	Read/write	Gets or sets a value that indicates the maximum permitted run-time value of ZoomFactor.
MaxZoomFactorProperty	Read-only	Identifies the MaxZoomFactor dependency property.
MinHeight	Read/write	Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement)
MinWidth	Read/write	Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement)
MinZoomFactor	Read/write	Gets or sets a value that indicates the minimum permitted run-time value of ZoomFactor.
MinZoomFactorProperty	Read-only	Identifies the MinZoomFactor dependency property.
Name	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)
Opacity	Read/write	Gets or sets the degree of the object's opacity. (Inherited from UIElement)
Padding	Read/write	Gets or sets the padding inside a control. (Inherited from Control)
Parent	Read-only	Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement)
PointerCaptures	Read-only	Gets the set of all captured pointers, represented as Pointer values. (Inherited from UIElement)
Projection	Read/write	Gets or sets the perspective projection (3-D effect) to apply when rendering this element. (Inherited from UIElement)
RenderSize	Read-only	Gets the final render size of a UIElement. (Inherited from UIElement)
RenderTransform	Read/write	Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement)
RenderTransformOrigin	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)
Resources	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)
ScrollableHeight	Read-only	Gets a value that represents the vertical size of the area that can be scrolled; the difference between the width of the extent and the width of the viewport.
ScrollableHeightProperty	Read-only	Identifies the ScrollableHeight dependency property.
ScrollableWidth	Read-only	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.
ScrollableWidthProperty	Read-only	Identifies the ScrollableWidth dependency property.
Style	Read/write	Gets or sets an instance Style that is applied for this object during layout and rendering. (Inherited from FrameworkElement)
TabIndex	Read/write	Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key. (Inherited from Control)
TabNavigation	Read/write	Gets or sets a value that modifies how tabbing and TabIndex work for this control. (Inherited from Control)
Tag	Read/write	Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement)
Template	Read/write	Gets or sets a control template. The control template defines the visual appearance of a control in UI, and is defined in XAML markup. (Inherited from Control)
Transitions	Read/write	Gets or sets the collection of Transition style elements that apply to a UIElement. (Inherited from UIElement)
Triggers	Read-only	Gets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. (Inherited from FrameworkElement)
UseLayoutRounding	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)
VerticalAlignment	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)
VerticalContentAlignment	Read/write	Gets or sets the vertical alignment of the control's content. (Inherited from Control)
VerticalOffset	Read-only	Gets the distance the content has been scrolled vertically.
VerticalOffsetProperty	Read-only	Identifies the VerticalOffset dependency property.
VerticalScrollBarVisibility	Read/write	Gets or sets a value that indicates whether a vertical ScrollBar should be displayed.
VerticalScrollBarVisibilityProperty	Read-only	Identifies the VerticalScrollBarVisibility dependency property.
VerticalScrollMode	Read/write	Gets or sets a value that determines how manipulation input influences scrolling behavior on the vertical axis.
VerticalScrollModeProperty	Read-only	Identifies the VerticalScrollMode dependency property.
VerticalSnapPointsAlignment	Read/write	Gets or sets a value that indicates how the existing snap points are vertically aligned versus the initial viewport.
VerticalSnapPointsAlignmentProperty	Read-only	Identifies the VerticalSnapPointsAlignment dependency property.
VerticalSnapPointsType	Read/write	Gets or sets a value that declares how manipulation behavior reacts to the snap points along the vertical axis.
VerticalSnapPointsTypeProperty	Read-only	Identifies the VerticalSnapPointsType dependency property.
ViewportHeight	Read-only	Gets the vertical size of the viewable content.
ViewportHeightProperty	Read-only	Identifies the ViewportHeight dependency property.
ViewportWidth	Read-only	Gets the horizontal size of the viewable content.
ViewportWidthProperty	Read-only	Identifies the ViewportWidth dependency property.
Visibility	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)
Width	Read/write	Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement)
ZoomFactor	Read-only	Gets a value that indicates the current zoom factor engaged for content scaling.
ZoomFactorProperty	Read-only	Identifies the ZoomFactor dependency property.
ZoomMode	Read/write	Gets or sets a value that indicates whether zoom behavior in the ScrollViewer content is enabled.
ZoomModeProperty	Read-only	Identifies the ZoomMode dependency property.
ZoomSnapPoints	Read-only	Gets the observable collection of zoom snap point factors that are held by the ScrollViewer.
ZoomSnapPointsProperty	Read-only	Identifies the ZoomSnapPoints dependency property.
ZoomSnapPointsType	Read/write	Gets or sets a value that indicates how zoom snap points are processed for interaction input.
ZoomSnapPointsTypeProperty	Read-only	Identifies the ZoomSnapPointsType dependency property.

Remarks

ScrollViewer XAML attached properties

ScrollViewer defines the following XAML attached properties:

These XAML attached properties are intended for cases where the ScrollViewer is implicit, such as when the ScrollViewer exists in the default template for a GridView, and you want to be able to influence the scrolling behavior without accessing template parts.

In order to support XAML processor access to the attached properties, and also to expose equivalent get and set operations to code, each XAML attached property has a pair of Get and Set accessor methods. For example, the GetHorizontalScrollMode and SetHorizontalScrollMode methods support and provide the equivalent code-only support for ScrollViewer.HorizontalScrollMode. Alternatively, you can use the dependency property system to get or set the value of the attached property. Call GetValue or SetValue, passing the arguments of the dependency property identifier to set, and a reference to the target object on which to get or set the value.

Examples

The following XAML creates a large TextBlock inside a ScrollViewer, along with another copy of the TextBlock for comparison.

XAML


  <StackPanel>
      <!-- A large TextBlock. -->
      <TextBlock Width="300" TextWrapping="Wrap" Margin="0,0,0,30" 
        Text="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed ac mi ipsum. Phasellus vel malesuada mauris. Donec pharetra, enim sit amet mattis tincidunt, felis nisi semper lectus, vel porta diam nisi in augue. Pellentesque lacus tortor, aliquam et faucibus id, rhoncus ut justo. Sed id lectus odio, eget pulvinar diam. Suspendisse eleifend ornare libero, in luctus purus aliquet non. Sed interdum, sem vitae rutrum rhoncus, felis ligula ultrices sem, in eleifend eros ante id neque." />
      
      <!-- The same large TextBlock, wrapped in a ScrollViewer. -->
      <ScrollViewer Height="200" Width="200" 
                    HorizontalScrollBarVisibility="Auto" 
                    VerticalScrollBarVisibility="Auto">
          <TextBlock Width="300" TextWrapping="Wrap"
              Text="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed ac mi ipsum. Phasellus vel malesuada mauris. Donec pharetra, enim sit amet mattis tincidunt, felis nisi semper lectus, vel porta diam nisi in augue. Pellentesque lacus tortor, aliquam et faucibus id, rhoncus ut justo. Sed id lectus odio, eget pulvinar diam. Suspendisse eleifend ornare libero, in luctus purus aliquet non. Sed interdum, sem vitae rutrum rhoncus, felis ligula ultrices sem, in eleifend eros ante id neque." />
      </ScrollViewer>
  </StackPanel>

Requirements

Minimum supported client	Windows 8 [Windows Store apps only]
Minimum supported server	Windows Server 2012 [Windows Store apps only]
Namespace	Windows.UI.Xaml.Controls Windows::UI::Xaml::Controls [C++]
Metadata	Windows.winmd

ScrollViewer class