EN
Este conteúdo não está disponível em seu idioma, mas aqui está a versão em inglês.

ScrollViewer class

Applies to Windows and Windows Phone

Represents a scrollable area that can contain other visible elements.

Inheritance

Object
  DependencyObject
    UIElement
      FrameworkElement
        Control
          ContentControl
            ScrollViewer

Syntax


public sealed class ScrollViewer : ContentControl


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

Attributes

[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06020000)]
[WebHostHidden()]

Members

The ScrollViewer class has these types of members:

Constructors

The ScrollViewer class has these constructors.

ConstructorDescription
ScrollViewer Initializes a new instance of the ScrollViewer class.

 

Events

The ScrollViewer class has these events.

EventDescription
DataContextChanged Occurs when the value of the FrameworkElement.DataContext property changes. (Inherited from FrameworkElement)
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, due to layout-relevant properties changing value or some other action that refreshes the layout. (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 such as scrolling and zooming have caused the view to change.
ViewChanging Occurs when manipulations such as scrolling and zooming cause the view to change.

 

Methods

The ScrollViewer class has these methods. It also inherits methods from the Object class.

MethodDescription
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)
CancelDirectManipulations Cancels ongoing direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement. (Inherited from UIElement)
CapturePointer Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events. (Inherited from UIElement)
ChangeView(IReference(Double), IReference(Double), IReference(Single)) Causes the ScrollViewer to load a new view into the viewport using the specified offsets and zoom factor.
ChangeView(IReference(Double), IReference(Double), IReference(Single), Boolean) Causes the ScrollViewer to load a new view into the viewport using the specified offsets and zoom factor, and optionally disables scrolling animation.
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)
GetBindingExpression Returns the BindingExpression that represents the binding on the specified property. (Inherited from FrameworkElement)
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.
GoToElementStateCore When implemented in a derived class, enables per-state construction of a visual tree for a control template in code, rather than by loading XAML for all states at control startup. (Inherited from FrameworkElement)
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.

PropertyAccess typeDescription

ActualHeight

Read-onlyGets the rendered height of a FrameworkElement. (Inherited from FrameworkElement)

ActualWidth

Read-onlyGets the rendered width of a FrameworkElement. (Inherited from FrameworkElement)

AllowDrop

Read/writeGets 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/writeGets or sets a brush that provides the background of the control. (Inherited from Control)

BaseUri

Read-onlyGets 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/writeGets or sets a brush that describes the border fill of a control. (Inherited from Control)

BorderThickness

Read/writeGets or sets the border thickness of a control. (Inherited from Control)

BringIntoViewOnFocusChange

Read/writeGets 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-onlyIdentifies the BringIntoViewOnFocusChange dependency property.

CacheMode

Read/writeGets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible. (Inherited from UIElement)

CharacterSpacing

Read/writeGets or sets the uniform spacing between characters, in units of 1/1000 of an em. (Inherited from Control)

Clip

Read/writeGets or sets the RectangleGeometry used to define the outline of the contents of a UIElement. (Inherited from UIElement)

CompositeMode

Read/writeGets or sets a property that declares alternate composition and blending modes for the element in its parent layout and window. This is relevant for elements that are involved in a mixed XAML / Microsoft DirectX UI. (Inherited from UIElement)

ComputedHorizontalScrollBarVisibility

Read-onlyGets a value that indicates whether the horizontal ScrollBar is visible.

ComputedHorizontalScrollBarVisibilityProperty

Read-onlyIdentifies the ComputedHorizontalScrollBarVisibility dependency property.

ComputedVerticalScrollBarVisibility

Read-onlyGets a value that indicates whether the vertical ScrollBar is visible.

ComputedVerticalScrollBarVisibilityProperty

Read-onlyIdentifies the ComputedVerticalScrollBarVisibility dependency property.

Content

Read/writeGets or sets the content of a ContentControl. (Inherited from ContentControl)

ContentTemplate

Read/writeGets or sets the data template that is used to display the content of the ContentControl. (Inherited from ContentControl)

ContentTemplateRoot

Read-onlyGets the root element of the date template specified by the ContentTemplate property. (Inherited from ContentControl)

ContentTemplateSelector

Read/writeGets 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/writeGets or sets the collection of Transition style elements that apply to the content of a ContentControl. (Inherited from ContentControl)

DataContext

Read/writeGets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement)

DefaultStyleKey

Read/writeGets or sets the key that references the default style for the control. Authors of custom controls use this property to change the default for the style that their control uses. (Inherited from Control)

DesiredSize

Read-onlyGets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement)

Dispatcher

Read-onlyGets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread. (Inherited from DependencyObject)

ExtentHeight

Read-onlyGets the vertical size of all the scrollable content in the ScrollViewer.

ExtentHeightProperty

Read-onlyIdentifier for the ExtentHeight dependency property.

ExtentWidth

Read-onlyGets the horizontal size of all the scrollable content in the ScrollViewer.

ExtentWidthProperty

Read-onlyIdentifier for the ExtentWidth dependency property.

FlowDirection

Read/writeGets 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-onlyGets a value that specifies whether this control has focus, and the mode by which focus was obtained. (Inherited from Control)

FontFamily

Read/writeGets or sets the font used to display text in the control. (Inherited from Control)

FontSize

Read/writeGets or sets the size of the text in this control. (Inherited from Control)

FontStretch

Read/writeGets or sets the degree to which a font is condensed or expanded on the screen. (Inherited from Control)

FontStyle

Read/writeGets or sets the style in which the text is rendered. (Inherited from Control)

FontWeight

Read/writeGets or sets the thickness of the specified font. (Inherited from Control)

Foreground

Read/writeGets or sets a brush that describes the foreground color. (Inherited from Control)

Height

Read/writeGets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement)

HorizontalAlignment

Read/writeGets 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/writeGets or sets the horizontal alignment of the control's content. (Inherited from Control)

HorizontalOffset

Read-onlyGets the distance the content has been scrolled horizontally.

HorizontalOffsetProperty

Read-onlyIdentifies the HorizontalOffset dependency property.

HorizontalScrollBarVisibility

Read/writeGets or sets a value that indicates whether a horizontal ScrollBar should be displayed.

HorizontalScrollBarVisibilityProperty

Read-onlyIdentifies the HorizontalScrollBarVisibility dependency property.

HorizontalScrollMode

Read/writeGets or sets a value that determines how manipulation input influences scrolling behavior on the horizontal axis.

HorizontalScrollModeProperty

Read-onlyIdentifies the HorizontalScrollMode dependency property.

HorizontalSnapPointsAlignment

Read/writeGets or sets a value that indicates how the existing snap points are horizontally aligned versus the initial viewport.

HorizontalSnapPointsAlignmentProperty

Read-onlyIdentifies the HorizontalSnapPointsAlignment dependency property.

HorizontalSnapPointsType

Read/writeGets or sets a value that declares how manipulation behavior reacts to the snap points along the horizontal axis.

HorizontalSnapPointsTypeProperty

Read-onlyIdentifies the HorizontalSnapPointsType dependency property.

IsDeferredScrollingEnabled

Read/writeGets or sets a value that determines the deferred scrolling behavior for a ScrollViewer.

IsDeferredScrollingEnabledProperty

Read-onlyIdentifies the IsDeferredScrollingEnabled dependency property.

IsDoubleTapEnabled

Read/writeGets or sets a value that determines whether the DoubleTapped event can originate from that element. (Inherited from UIElement)

IsEnabled

Read/writeGets or sets a value indicating whether the user can interact with the control. (Inherited from Control)

IsHitTestVisible

Read/writeGets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement)

IsHoldingEnabled

Read/writeGets or sets a value that determines whether the Holding event can originate from that element. (Inherited from UIElement)

IsHorizontalRailEnabled

Read/writeGets or sets a value that indicates whether the scroll rail is enabled for the horizontal axis.

IsHorizontalRailEnabledProperty

Read-onlyIdentifies the IsHorizontalRailEnabled dependency property.

IsHorizontalScrollChainingEnabled

Read/writeGets or sets a value that indicates whether scroll chaining is enabled from this child to its parent, for the horizontal axis.

IsHorizontalScrollChainingEnabledProperty

Read-onlyIdentifies the IsHorizontalScrollChainingEnabled dependency property.

IsRightTapEnabled

Read/writeGets or sets a value that determines whether the RightTapped event can originate from that element. (Inherited from UIElement)

IsScrollInertiaEnabled

Read/writeGets or sets a value that indicates whether scroll actions should include inertia in their behavior and value.

IsScrollInertiaEnabledProperty

Read-onlyIdentifies the IsScrollInertiaEnabled dependency property.

IsTabStop

Read/writeGets or sets a value that indicates whether a control is included in tab navigation. (Inherited from Control)

IsTapEnabled

Read/writeGets or sets a value that determines whether the Tapped event can originate from that element. (Inherited from UIElement)

IsTextScaleFactorEnabled

Read/writeGets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled. (Inherited from Control)

IsVerticalRailEnabled

Read/writeGets or sets a value that indicates whether the scroll rail is enabled for the vertical axis.

IsVerticalRailEnabledProperty

Read-onlyIdentifies the IsVerticalRailEnabled dependency property.

IsVerticalScrollChainingEnabled

Read/writeGets or sets a value that indicates whether scroll chaining is enabled from this child to its parent, for the vertical axis.

IsVerticalScrollChainingEnabledProperty

Read-onlyIdentifies the IsVerticalScrollChainingEnabled dependency property.

IsZoomChainingEnabled

Read/writeGets or sets a value that indicates whether zoom chaining is enabled from this child to its parent.

IsZoomChainingEnabledProperty

Read-onlyIdentifies the IsZoomChainingEnabled dependency property.

IsZoomInertiaEnabled

Read/writeGets or sets a value that indicates whether zoom actions should include inertia in their behavior and value.

IsZoomInertiaEnabledProperty

Read-onlyIdentifies the IsZoomInertiaEnabled dependency property.

Language

Read/writeGets 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)

LeftHeader

Read/writeGets or sets the content of the left header.

LeftHeaderProperty

Read-onlyIdentifies the LeftHeader dependency property.

ManipulationMode

Read/writeGets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. Setting this value enables handling the manipulation events from this element in app code. (Inherited from UIElement)

Margin

Read/writeGets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement)

MaxHeight

Read/writeGets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement)

MaxWidth

Read/writeGets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement)

MaxZoomFactor

Read/writeGets or sets a value that indicates the maximum permitted run-time value of ZoomFactor.

MaxZoomFactorProperty

Read-onlyIdentifies the MaxZoomFactor dependency property.

MinHeight

Read/writeGets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement)

MinWidth

Read/writeGets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement)

MinZoomFactor

Read/writeGets or sets a value that indicates the minimum permitted run-time value of ZoomFactor.

MinZoomFactorProperty

Read-onlyIdentifies the MinZoomFactor dependency property.

Name

Read/writeGets 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/writeGets or sets the degree of the object's opacity. (Inherited from UIElement)

Padding

Read/writeGets or sets the padding inside a control. (Inherited from Control)

Parent

Read-onlyGets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement)

PointerCaptures

Read-onlyGets the set of all captured pointers, represented as Pointer values. (Inherited from UIElement)

Projection

Read/writeGets or sets the perspective projection (3-D effect) to apply when rendering this element. (Inherited from UIElement)

RenderSize

Read-onlyGets the final render size of a UIElement. (Inherited from UIElement)

RenderTransform

Read/writeGets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement)

RenderTransformOrigin

Read/writeGets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement)

RequestedTheme

Read/writeGets or sets the UI theme that is used by the UIElement (and its child elements) for resource determination. The UI theme you specify with RequestedTheme can override the app-level RequestedTheme. (Inherited from FrameworkElement)

Resources

Read/writeGets 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-onlyGets 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-onlyIdentifies the ScrollableHeight dependency property.

ScrollableWidth

Read-onlyGets 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-onlyIdentifies the ScrollableWidth dependency property.

Style

Read/writeGets or sets an instance Style that is applied for this object during layout and rendering. (Inherited from FrameworkElement)

TabIndex

Read/writeGets 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/writeGets or sets a value that modifies how tabbing and TabIndex work for this control. (Inherited from Control)

Tag

Read/writeGets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement)

Template

Read/writeGets 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)

TopHeader

Read/writeGets or sets the content of the top header.

TopHeaderProperty

Read-onlyIdentifies the TopHeader dependency property.

TopLeftHeader

Read/writeGets or sets the content of the top, left header.

TopLeftHeaderProperty

Read-onlyIdentifies the TopLeftHeader dependency property.

Transitions

Read/writeGets or sets the collection of Transition style elements that apply to a UIElement. (Inherited from UIElement)

Triggers

Read-onlyGets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. (Inherited from FrameworkElement)

UseLayoutRounding

Read/writeGets 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/writeGets 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/writeGets or sets the vertical alignment of the control's content. (Inherited from Control)

VerticalOffset

Read-onlyGets the distance the content has been scrolled vertically.

VerticalOffsetProperty

Read-onlyIdentifies the VerticalOffset dependency property.

VerticalScrollBarVisibility

Read/writeGets or sets a value that indicates whether a vertical ScrollBar should be displayed.

VerticalScrollBarVisibilityProperty

Read-onlyIdentifies the VerticalScrollBarVisibility dependency property.

VerticalScrollMode

Read/writeGets or sets a value that determines how manipulation input influences scrolling behavior on the vertical axis.

VerticalScrollModeProperty

Read-onlyIdentifies the VerticalScrollMode dependency property.

VerticalSnapPointsAlignment

Read/writeGets or sets a value that indicates how the existing snap points are vertically aligned versus the initial viewport.

VerticalSnapPointsAlignmentProperty

Read-onlyIdentifies the VerticalSnapPointsAlignment dependency property.

VerticalSnapPointsType

Read/writeGets or sets a value that declares how manipulation behavior reacts to the snap points along the vertical axis.

VerticalSnapPointsTypeProperty

Read-onlyIdentifies the VerticalSnapPointsType dependency property.

ViewportHeight

Read-onlyGets the vertical size of the viewable content.

ViewportHeightProperty

Read-onlyIdentifies the ViewportHeight dependency property.

ViewportWidth

Read-onlyGets the horizontal size of the viewable content.

ViewportWidthProperty

Read-onlyIdentifies the ViewportWidth dependency property.

Visibility

Read/writeGets 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/writeGets or sets the width of a FrameworkElement. (Inherited from FrameworkElement)

ZoomFactor

Read-onlyGets a value that indicates the current zoom factor engaged for content scaling.

ZoomFactorProperty

Read-onlyIdentifies the ZoomFactor dependency property.

ZoomMode

Read/writeGets or sets a value that indicates whether zoom behavior in the ScrollViewer content is enabled.

ZoomModeProperty

Read-onlyIdentifies the ZoomMode dependency property.

ZoomSnapPoints

Read-onlyGets the observable collection of zoom snap point factors that are held by the ScrollViewer.

ZoomSnapPointsProperty

Read-onlyIdentifies the ZoomSnapPoints dependency property.

ZoomSnapPointsType

Read/writeGets or sets a value that indicates how zoom snap points are processed for interaction input.

ZoomSnapPointsTypeProperty

Read-onlyIdentifies the ZoomSnapPointsType dependency property.

 

Remarks

ScrollViewer is a container control that lets the user pan and zoom its content.

Scroll viewer control

A ScrollViewer enables content to be displayed in a smaller area than its actual size. When the content of the ScrollViewer is not entirely visible, the ScrollViewer displays scrollbars that the user can use to move the content areas that is visible. The area that includes all of the content of the ScrollViewer is the extent. The visible area of the content is the viewport.

It's uncommon to declare a ScrollViewer element as part of app page UI. It's more typical for a ScrollViewer control to exist as a composite part of other controls. A ScrollViewer part along with the ScrollContentPresenter class for support will display a viewport along with scrollbars only when the host control's layout space is being constrained smaller than the expanded content size. This is often the case for lists, so ListView and GridView templates always include a ScrollViewer. TextBox and RichEditBox also include a ScrollViewer in their templates.

When a ScrollViewer part in a control exists, the host control often has built-in event handling for certain input events and manipulations that enable the content to scroll. For example, a GridView interprets a swipe gesture and this causes the content to scroll horizontally. The input events and raw manipulations that the host control receives are considered handled by the control, and lower-level events such as PointerPressed won't be raised and won't bubble to any parent containers either. You can change some of the built-in control handling by overriding a control class and the On* virtual methods for events, or by retemplating the control. But in either case it's not trivial to reproduce the original default behavior, which is typically there so that the control reacts in expected ways to events and to a user's input actions and gestures. So you should consider whether you really need that input event to fire. You might want to investigate whether there are other input events or gestures that are not being control-handled, and use those in your app or control interaction design.

To make it possible for controls that include a ScrollViewer to influence some of the behavior and properties that are from within the ScrollViewer part, ScrollViewer defines a number of XAML attached properties that can be set in styles and used in template bindings.

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 ListView or GridView, and you want to be able to influence the scrolling behavior of the control without accessing template parts. For cases where a ScrollViewer is explicit in your XAML, as is shown in the example code in the Examples section, you don't need to use attached property syntax. Just use attribute syntax, for example <ScrollViewer ZoomMode="Enabled" />.

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.

Windows 8 behavior

Gesture handling by track pad devices

For Windows 8, track pad device gestures that were input-handled by a ScrollViewer control part were interpreted as mouse wheel input, and thus would fire a PointerWheelChanged event. Starting with Windows 8.1, ScrollViewer uses an underlying manipulation logic that interprets track pad gestures as actions that the ScrollViewer responds to, and thus the gesture is considered handled by the control and the PointerWheelChanged event is not fired anymore.

If you migrate your app code from Windows 8 to Windows 8.1 you may want to account for this behavior change, because it results in PointerWheelChanged being fired in fewer cases. Also, the behavior that's now built-in to ScrollViewer may be duplicating what your handler would have done.

Apps that were compiled for Windows 8 but running on Windows 8.1 continue to use the Windows 8 behavior.

App UI for On-Screen Keyboard

Windows 8 had an internally implemented logic that would associate a ScrollViewer with the overall app UI whenever the user invokes the On-Screen Keyboard. This On-Screen Keyboard is a specific accessibility feature that users request through the Ease of Access Center. It's not the same as the soft keyboard that can appear in app UI for text input controls, if the system detects no keyboard device. What the internal ScrollViewer does here is to make it possible to scroll the area where the app is, if scrolling it is forced because the keyboard is taking UI space.

Starting with Windows 8.1, the system still has UI/layout behavior when the On-Screen Keyboard appears, but it no longer uses this internally created ScrollViewer. Instead it uses a dedicated internal control that app code can't change or inspect.

Most aspects of this behavior change don't affect apps at all. However, your app might have anticipated this behavior, by providing an implicit Style for ScrollViewer that's meant to change the layout, or by walking the tree with VisualTreeHelper to find this internally created ScrollViewer and alter it at run-time. For an app that is compiled for Windows 8.1 that code won't be useful.

Apps that were compiled for Windows 8 but running on Windows 8.1 continue to use the Windows 8 behavior.

Examples

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


  <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]

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Controls
Windows::UI::Xaml::Controls [C++]

Metadata

Windows.winmd

See also

ContentControl
Adding ListView and GridView controls

 

 

Mostrar:
© 2014 Microsoft