ScrollViewer ScrollViewer ScrollViewer ScrollViewer Class

Definition

Represents a scrollable area that can contain other visible elements.

public : sealed class ScrollViewer : ContentControl, IScrollViewer, IScrollViewer2, IScrollViewer3
struct winrt::Windows::UI::Xaml::Controls::ScrollViewer : ContentControl, IScrollViewer, IScrollViewer2, IScrollViewer3
public sealed class ScrollViewer : ContentControl, IScrollViewer, IScrollViewer2, IScrollViewer3
Public NotInheritable Class ScrollViewer Inherits ContentControl Implements IScrollViewer, IScrollViewer2, IScrollViewer3
<ScrollViewer .../>
-or-
<ScrollViewer ...>
content
</ScrollViewer>
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

XAML Controls Gallery
XAML controls gallery

If you have the XAML Controls Gallery app installed, click here to open the app and see the ScrollViewer in action.

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>

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

Pen interaction

Prerelease. Fall Creators Update (Windows 10 Insider Preview Build 16215 and later) - Behavior change

By default, instead of text selection, an active pen now scrolls/pans in UWP apps (just like touch, touchpad, and passive pen). The ScrollViewer consumes pointer events unless you specify that you want to handle the events yourself, and don't want them to be used for manipulation.

If your app depends on the previous behavior, you can override pen scrolling and revert to the previous behavior. To do this, handle the PointerPressed event and set the ManipulationMode property to specify that the system should not handle pen interaction to scroll your main ScrollViewer. You also handle the PointerReleased and PointerCanceled events to turn the default system behavior back on when the Pen is removed.

This example shows how to:

  • Register the events using the AddHandler method with the handledEventsToo parameter set to true.
  • Check if the pointer device is a Pen.
  • In the PointerPressed event handler, turn off system manipulation support in the ScrollViewer.
  • In the PointerReleased and PointerCanceled event handlers, turn back on system manipulation support.
<Grid Background="{ThemeResource ApplicationPageBackgroundThemeBrush}">
    <ScrollViewer x:Name="myScrollViewer">
        <Image Source="Assets/StoreLogo.png"/>
    </ScrollViewer>
</Grid>
public MainPage()
{
    this.InitializeComponent();

    this.myScrollViewer.AddHandler(UIElement.PointerPressedEvent, 
        new PointerEventHandler(myScrollViewer_PointerPressed), 
        true /*handledEventsToo*/);
    this.myScrollViewer.AddHandler(UIElement.PointerReleasedEvent, 
        new PointerEventHandler(myScrollViewer_PointerReleased), 
        true /*handledEventsToo*/);
    this.myScrollViewer.AddHandler(UIElement.PointerCanceledEvent, 
        new PointerEventHandler(myScrollViewer_PointerCanceled), 
        true /*handledEventsToo*/);
}

private void myScrollViewer_PointerPressed(object sender, PointerRoutedEventArgs e)
{
    if (e.Pointer.PointerDeviceType == Windows.Devices.Input.PointerDeviceType.Pen)
    {
        (myScrollViewer.Content as UIElement).ManipulationMode &= ~ManipulationModes.System;
    }
}

private void myScrollViewer_PointerReleased(object sender, PointerRoutedEventArgs e)
{
    if (e.Pointer.PointerDeviceType == Windows.Devices.Input.PointerDeviceType.Pen)
    {
        (myScrollViewer.Content as UIElement).ManipulationMode |= ManipulationModes.System;
    }
}

private void myScrollViewer_PointerCanceled(object sender, PointerRoutedEventArgs e)
{
    if (e.Pointer.PointerDeviceType == Windows.Devices.Input.PointerDeviceType.Pen)
    {
        (myScrollViewer.Content as UIElement).ManipulationMode |= ManipulationModes.System;
    }
}

ScrollViewer XAML attached properties

ScrollViewer defines the following XAML attached properties:

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.

Control style and template

You can modify the default Style and ControlTemplate to give the control a unique appearance. For information about modifying a control's style and template, see Styling controls. The default style, template, and resources that define the look of the control are included in the generic.xaml file. For design purposes, generic.xaml is available in the (Program Files)\Windows Kits\10\DesignTime\CommonConfiguration\Neutral\UAP&lt;SDK version>\Generic folder from a Windows Software Development Kit (SDK) installation. Styles and resources from different versions of the SDK might have different values.

Starting in Windows 10, version 1607 (Windows Software Development Kit (SDK) version 10.0.14393.0), generic.xaml includes resources that you can use to modify the colors of a control in different visual states without modifying the control template. In apps that target this software development kit (SDK) or later, modifying these resources is preferred to setting properties such as Background and Foreground. For more info, see the Light-weight styling section of the Styling controls article.

This table shows the resources used by the ScrollViewer control.

Resource keyDescription
ScrollViewerScrollBarSeparatorBackgroundBackground color of the scrollbar separator

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.

Constructors

ScrollViewer() ScrollViewer() ScrollViewer() ScrollViewer()

Initializes a new instance of the ScrollViewer class.

public : ScrollViewer()
ScrollViewer() const;
public ScrollViewer()
Public Sub New()

Properties

AccessKey AccessKey AccessKey AccessKey

Gets or sets the access key (mnemonic) for this element.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AccessKeyProperty AccessKeyProperty AccessKeyProperty AccessKeyProperty

Identifies for the AccessKey dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AccessKeyScopeOwner AccessKeyScopeOwner AccessKeyScopeOwner AccessKeyScopeOwner

Gets or sets a source element that provides the access key scope for this element, even if it's not in the visual tree of the source element.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AccessKeyScopeOwnerProperty AccessKeyScopeOwnerProperty AccessKeyScopeOwnerProperty AccessKeyScopeOwnerProperty

Identifies for the AccessKeyScopeOwner dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

ActualHeight ActualHeight ActualHeight ActualHeight

Gets the rendered height of a FrameworkElement. See Remarks.

(Inherited from FrameworkElement)

ActualHeightProperty ActualHeightProperty ActualHeightProperty ActualHeightProperty

Identifies the ActualHeight dependency property. See Remarks.

(Inherited from FrameworkElement)

ActualTheme ActualTheme ActualTheme ActualTheme

Gets the UI theme that is currently used by the element, which might be different than the RequestedTheme.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

ActualThemeProperty ActualThemeProperty ActualThemeProperty ActualThemeProperty

Identifies the ActualTheme dependency property.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

ActualWidth ActualWidth ActualWidth ActualWidth

Gets the rendered width of a FrameworkElement. See Remarks.

(Inherited from FrameworkElement)

ActualWidthProperty ActualWidthProperty ActualWidthProperty ActualWidthProperty

Identifies the ActualWidth dependency property. See Remarks.

(Inherited from FrameworkElement)

AllowDrop AllowDrop AllowDrop AllowDrop

Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations.

(Inherited from UIElement)

AllowDropProperty AllowDropProperty AllowDropProperty AllowDropProperty

Identifies the AllowDrop dependency property.

(Inherited from UIElement)

AllowFocusOnInteraction AllowFocusOnInteraction AllowFocusOnInteraction AllowFocusOnInteraction

Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty

Identifies for the AllowFocusOnInteraction dependency property.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AllowFocusWhenDisabled AllowFocusWhenDisabled AllowFocusWhenDisabled AllowFocusWhenDisabled

Gets or sets whether a disabled control can receive focus.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AllowFocusWhenDisabledProperty AllowFocusWhenDisabledProperty AllowFocusWhenDisabledProperty AllowFocusWhenDisabledProperty

Identifies the AllowFocusWhenDisabled dependency property.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Background Background Background Background

Gets or sets a brush that provides the background of the control.

(Inherited from Control)

BackgroundProperty BackgroundProperty BackgroundProperty BackgroundProperty

Identifies the Background dependency property.

(Inherited from Control)

BaseUri BaseUri BaseUri BaseUri

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

Gets or sets a brush that describes the border fill of a control.

(Inherited from Control)

BorderBrushProperty BorderBrushProperty BorderBrushProperty BorderBrushProperty

Identifies the BorderBrush dependency property.

(Inherited from Control)

BorderThickness BorderThickness BorderThickness BorderThickness

Gets or sets the border thickness of a control.

(Inherited from Control)

BorderThicknessProperty BorderThicknessProperty BorderThicknessProperty BorderThicknessProperty

Identifies the BorderThickness dependency property.

(Inherited from Control)

BringIntoViewOnFocusChange BringIntoViewOnFocusChange BringIntoViewOnFocusChange BringIntoViewOnFocusChange

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.

public : Platform::Boolean BringIntoViewOnFocusChange { get; set; }
bool BringIntoViewOnFocusChange(); void BringIntoViewOnFocusChange(bool bringintoviewonfocuschange);
public bool BringIntoViewOnFocusChange { get; set; }
Public ReadWrite Property BringIntoViewOnFocusChange As bool
<ScrollViewer BringIntoViewOnFocusChange="bool" />
-or-
<object ScrollViewer.BringIntoViewOnFocusChange="bool"/>
Value
bool bool

true to use a behavior that brings focused items into view. false to use a behavior that focused items do not automatically scroll into view. The default is true.

Remarks

For XAML usage, BringIntoViewOnFocusChange can either be an attribute on an explicit ScrollViewer element, or a ScrollViewer.BringIntoViewOnFocusChange attached property usage on an element that is a child of a control that supports scrollview implicitly in its template.

BringIntoViewOnFocusChangeProperty BringIntoViewOnFocusChangeProperty BringIntoViewOnFocusChangeProperty BringIntoViewOnFocusChangeProperty

Identifies the BringIntoViewOnFocusChange dependency property.

public : static DependencyProperty BringIntoViewOnFocusChangeProperty { get; }
static DependencyProperty BringIntoViewOnFocusChangeProperty();
public static DependencyProperty BringIntoViewOnFocusChangeProperty { get; }
Public Static ReadOnly Property BringIntoViewOnFocusChangeProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the BringIntoViewOnFocusChange dependency property.

BringIntoViewRequestedEvent BringIntoViewRequestedEvent BringIntoViewRequestedEvent BringIntoViewRequestedEvent

Prerelease. Gets the identifier for the BringIntoViewRequested routed event.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.17095.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v6)

CacheMode CacheMode CacheMode CacheMode

Gets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible.

(Inherited from UIElement)

CacheModeProperty CacheModeProperty CacheModeProperty CacheModeProperty

Identifies the CacheMode dependency property.

(Inherited from UIElement)

CanDrag CanDrag CanDrag CanDrag

Gets or sets a value that indicates whether the element can be dragged as data in a drag-and-drop operation.

(Inherited from UIElement)

CanDragProperty CanDragProperty CanDragProperty CanDragProperty

Identifies the CanDrag dependency property.

(Inherited from UIElement)

CharacterReceivedEvent CharacterReceivedEvent CharacterReceivedEvent CharacterReceivedEvent

Gets the identifier for the CharacterReceived routed event.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

CharacterSpacing CharacterSpacing CharacterSpacing CharacterSpacing

Gets or sets the uniform spacing between characters, in units of 1/1000 of an em.

(Inherited from Control)

CharacterSpacingProperty CharacterSpacingProperty CharacterSpacingProperty CharacterSpacingProperty

Identifies the CharacterSpacing dependency property.

(Inherited from Control)

Clip Clip Clip Clip

Gets or sets the RectangleGeometry used to define the outline of the contents of a UIElement.

(Inherited from UIElement)

ClipProperty ClipProperty ClipProperty ClipProperty

Identifies the Clip dependency property.

(Inherited from UIElement)

CompositeMode CompositeMode CompositeMode CompositeMode

Gets 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)

CompositeModeProperty CompositeModeProperty CompositeModeProperty CompositeModeProperty

Identifies the CompositeMode dependency property.

(Inherited from UIElement)

ComputedHorizontalScrollBarVisibility ComputedHorizontalScrollBarVisibility ComputedHorizontalScrollBarVisibility ComputedHorizontalScrollBarVisibility

Gets a value that indicates whether the horizontal ScrollBar is visible.

public : Visibility ComputedHorizontalScrollBarVisibility { get; }
Visibility ComputedHorizontalScrollBarVisibility();
public Visibility ComputedHorizontalScrollBarVisibility { get; }
Public ReadOnly Property ComputedHorizontalScrollBarVisibility As Visibility
Value
Visibility Visibility

A Visibility that indicates whether the horizontal scroll bar is visible. The default value is Hidden.

ComputedHorizontalScrollBarVisibilityProperty ComputedHorizontalScrollBarVisibilityProperty ComputedHorizontalScrollBarVisibilityProperty ComputedHorizontalScrollBarVisibilityProperty

Identifies the ComputedHorizontalScrollBarVisibility dependency property.

public : static DependencyProperty ComputedHorizontalScrollBarVisibilityProperty { get; }
static DependencyProperty ComputedHorizontalScrollBarVisibilityProperty();
public static DependencyProperty ComputedHorizontalScrollBarVisibilityProperty { get; }
Public Static ReadOnly Property ComputedHorizontalScrollBarVisibilityProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the ComputedHorizontalScrollBarVisibility dependency property.

ComputedVerticalScrollBarVisibility ComputedVerticalScrollBarVisibility ComputedVerticalScrollBarVisibility ComputedVerticalScrollBarVisibility

Gets a value that indicates whether the vertical ScrollBar is visible.

public : Visibility ComputedVerticalScrollBarVisibility { get; }
Visibility ComputedVerticalScrollBarVisibility();
public Visibility ComputedVerticalScrollBarVisibility { get; }
Public ReadOnly Property ComputedVerticalScrollBarVisibility As Visibility
Value
Visibility Visibility

A Visibility that indicates whether the vertical scroll bar is visible. The default value is Visible.

ComputedVerticalScrollBarVisibilityProperty ComputedVerticalScrollBarVisibilityProperty ComputedVerticalScrollBarVisibilityProperty ComputedVerticalScrollBarVisibilityProperty

Identifies the ComputedVerticalScrollBarVisibility dependency property.

public : static DependencyProperty ComputedVerticalScrollBarVisibilityProperty { get; }
static DependencyProperty ComputedVerticalScrollBarVisibilityProperty();
public static DependencyProperty ComputedVerticalScrollBarVisibilityProperty { get; }
Public Static ReadOnly Property ComputedVerticalScrollBarVisibilityProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the ComputedVerticalScrollBarVisibility dependency property.

Content Content Content Content

Gets or sets the content of a ContentControl.

(Inherited from Windows.UI.Xaml.ControlsControl.Content)

ContentProperty ContentProperty ContentProperty ContentProperty

Identifies the Content dependency property.

(Inherited from ContentControl)

ContentTemplate ContentTemplate ContentTemplate ContentTemplate

Gets or sets the data template that is used to display the content of the ContentControl.

(Inherited from ContentControl)

ContentTemplateProperty ContentTemplateProperty ContentTemplateProperty ContentTemplateProperty

Identifies the ContentTemplate dependency property

(Inherited from ContentControl)

ContentTemplateRoot ContentTemplateRoot ContentTemplateRoot ContentTemplateRoot

Gets the root element of the data template specified by the ContentTemplate property.

(Inherited from ContentControl)

ContentTemplateSelector ContentTemplateSelector ContentTemplateSelector ContentTemplateSelector

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)

ContentTemplateSelectorProperty ContentTemplateSelectorProperty ContentTemplateSelectorProperty ContentTemplateSelectorProperty

Identifies the ContentTemplateSelector dependency property.

(Inherited from ContentControl)

ContentTransitions ContentTransitions ContentTransitions ContentTransitions

Gets or sets the collection of Transition style elements that apply to the content of a ContentControl.

(Inherited from ContentControl)

ContentTransitionsProperty ContentTransitionsProperty ContentTransitionsProperty ContentTransitionsProperty

Identifies the ContentTransitions dependency property.

(Inherited from ContentControl)

ContextFlyout ContextFlyout ContextFlyout ContextFlyout

Gets or sets the flyout associated with this element.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

ContextFlyoutProperty ContextFlyoutProperty ContextFlyoutProperty ContextFlyoutProperty

Identifies for the ContextFlyout dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

ContextRequestedEvent ContextRequestedEvent ContextRequestedEvent ContextRequestedEvent

Prerelease. Gets the identifier for the ContextRequested routed event.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.17095.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v6)

DataContext DataContext DataContext DataContext

Gets or sets the data context for a FrameworkElement when it participates in data binding.

(Inherited from FrameworkElement)

DataContextProperty DataContextProperty DataContextProperty DataContextProperty

Identifies the DataContext dependency property.

(Inherited from FrameworkElement)

DefaultStyleKey DefaultStyleKey DefaultStyleKey DefaultStyleKey

Gets 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)

DefaultStyleKeyProperty DefaultStyleKeyProperty DefaultStyleKeyProperty DefaultStyleKeyProperty

Identifies the DefaultStyleKey dependency property.

(Inherited from Control)

DefaultStyleResourceUri DefaultStyleResourceUri DefaultStyleResourceUri DefaultStyleResourceUri

Gets or sets the path to the resource file that contains the default style for the control.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

DefaultStyleResourceUriProperty DefaultStyleResourceUriProperty DefaultStyleResourceUriProperty DefaultStyleResourceUriProperty

Identifies the DefaultStyleResourceUri dependency property.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

DesiredSize DesiredSize DesiredSize DesiredSize

Gets the size that this UIElement computed during the measure pass of the layout process.

(Inherited from UIElement)

Dispatcher Dispatcher Dispatcher Dispatcher

Gets 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)

DoubleTappedEvent DoubleTappedEvent DoubleTappedEvent DoubleTappedEvent

Gets the identifier for the DoubleTapped routed event.

(Inherited from UIElement)

DragEnterEvent DragEnterEvent DragEnterEvent DragEnterEvent

Gets the identifier for the DragEnter routed event.

(Inherited from UIElement)

DragLeaveEvent DragLeaveEvent DragLeaveEvent DragLeaveEvent

Gets the identifier for the DragLeave routed event.

(Inherited from UIElement)

DragOverEvent DragOverEvent DragOverEvent DragOverEvent

Gets the identifier for the DragOver routed event.

(Inherited from UIElement)

DropEvent DropEvent DropEvent DropEvent

Gets the identifier for the Drop routed event.

(Inherited from UIElement)

ElementSoundMode ElementSoundMode ElementSoundMode ElementSoundMode

Get or sets a value that specifies a control's preference for whether sounds are played.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

ElementSoundModeProperty ElementSoundModeProperty ElementSoundModeProperty ElementSoundModeProperty

Identifies the ElementSoundMode dependency property.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

ExitDisplayModeOnAccessKeyInvoked ExitDisplayModeOnAccessKeyInvoked ExitDisplayModeOnAccessKeyInvoked ExitDisplayModeOnAccessKeyInvoked

Gets or sets a value that specifies whether the access key display is dismissed when an access key is invoked.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

ExitDisplayModeOnAccessKeyInvokedProperty ExitDisplayModeOnAccessKeyInvokedProperty ExitDisplayModeOnAccessKeyInvokedProperty ExitDisplayModeOnAccessKeyInvokedProperty

Identifies the ExitDisplayModeOnAccessKeyInvoked dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

ExtentHeight ExtentHeight ExtentHeight ExtentHeight

Gets the vertical size of all the scrollable content in the ScrollViewer.

public : double ExtentHeight { get; }
double ExtentHeight();
public double ExtentHeight { get; }
Public ReadOnly Property ExtentHeight As double
Value
double double

The vertical size of all the scrollable content in the ScrollViewer.

Remarks

The extent includes all the content in the ScrollViewer, whether visible or not. The viewport is the visible area of the content.

See Also

ExtentHeightProperty ExtentHeightProperty ExtentHeightProperty ExtentHeightProperty

Identifier for the ExtentHeight dependency property.

public : static DependencyProperty ExtentHeightProperty { get; }
static DependencyProperty ExtentHeightProperty();
public static DependencyProperty ExtentHeightProperty { get; }
Public Static ReadOnly Property ExtentHeightProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the ExtentHeight dependency property.

ExtentWidth ExtentWidth ExtentWidth ExtentWidth

Gets the horizontal size of all the scrollable content in the ScrollViewer.

public : double ExtentWidth { get; }
double ExtentWidth();
public double ExtentWidth { get; }
Public ReadOnly Property ExtentWidth As double
Value
double double

The horizontal size of all the scrollable content in the ScrollViewer.

Remarks

The extent includes all the content in the ScrollViewer, whether visible or not. The viewport is the visible area of the content.

See Also

ExtentWidthProperty ExtentWidthProperty ExtentWidthProperty ExtentWidthProperty

Identifier for the ExtentWidth dependency property.

public : static DependencyProperty ExtentWidthProperty { get; }
static DependencyProperty ExtentWidthProperty();
public static DependencyProperty ExtentWidthProperty { get; }
Public Static ReadOnly Property ExtentWidthProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the ExtentWidth dependency property.

FlowDirection FlowDirection FlowDirection FlowDirection

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)

FlowDirectionProperty FlowDirectionProperty FlowDirectionProperty FlowDirectionProperty

Identifies the FlowDirection dependency property.

(Inherited from FrameworkElement)

FocusState FocusState FocusState FocusState

Gets a value that specifies whether this control has focus, and the mode by which focus was obtained.

(Inherited from Control)

FocusStateProperty FocusStateProperty FocusStateProperty FocusStateProperty

Identifies the FocusState dependency property.

(Inherited from Control)

FocusVisualMargin FocusVisualMargin FocusVisualMargin FocusVisualMargin

Gets or sets the outer margin of the focus visual for a FrameworkElement.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusVisualMarginProperty FocusVisualMarginProperty FocusVisualMarginProperty FocusVisualMarginProperty

Identifies the FocusVisualMargin dependency property.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusVisualPrimaryBrush FocusVisualPrimaryBrush FocusVisualPrimaryBrush FocusVisualPrimaryBrush

Gets or sets the brush used to draw the outer border of a HighVisibility focus visual for a FrameworkElement.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusVisualPrimaryBrushProperty FocusVisualPrimaryBrushProperty FocusVisualPrimaryBrushProperty FocusVisualPrimaryBrushProperty

Identifies the FocusVisualPrimaryBrush dependency property.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusVisualPrimaryThickness FocusVisualPrimaryThickness FocusVisualPrimaryThickness FocusVisualPrimaryThickness

Gets or sets the thickness of the outer border of a HighVisibility focus visual for a FrameworkElement.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusVisualPrimaryThicknessProperty FocusVisualPrimaryThicknessProperty FocusVisualPrimaryThicknessProperty FocusVisualPrimaryThicknessProperty

Identifies the FocusVisualPrimaryThickness dependency property.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusVisualSecondaryBrush FocusVisualSecondaryBrush FocusVisualSecondaryBrush FocusVisualSecondaryBrush

Gets or sets the brush used to draw the inner border of a HighVisibility focus visual for a FrameworkElement.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusVisualSecondaryBrushProperty FocusVisualSecondaryBrushProperty FocusVisualSecondaryBrushProperty FocusVisualSecondaryBrushProperty

Identifies the FocusVisualSecondaryBrush dependency property.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusVisualSecondaryThickness FocusVisualSecondaryThickness FocusVisualSecondaryThickness FocusVisualSecondaryThickness

Gets or sets the thickness of the inner border of a HighVisibility focus visual for a FrameworkElement.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusVisualSecondaryThicknessProperty FocusVisualSecondaryThicknessProperty FocusVisualSecondaryThicknessProperty FocusVisualSecondaryThicknessProperty

Identifies the FocusVisualSecondaryThickness dependency property.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FontFamily FontFamily FontFamily FontFamily

Gets or sets the font used to display text in the control.

(Inherited from Control)

FontFamilyProperty FontFamilyProperty FontFamilyProperty FontFamilyProperty

Identifies the FontFamily dependency property.

(Inherited from Control)

FontSize FontSize FontSize FontSize

Gets or sets the size of the text in this control.

(Inherited from Control)

FontSizeProperty FontSizeProperty FontSizeProperty FontSizeProperty

Identifies the FontSize dependency property.

(Inherited from Control)

FontStretch FontStretch FontStretch FontStretch

Gets or sets the degree to which a font is condensed or expanded on the screen.

(Inherited from Control)

FontStretchProperty FontStretchProperty FontStretchProperty FontStretchProperty

Identifies the FontStretch dependency property.

(Inherited from Control)

FontStyle FontStyle FontStyle FontStyle

Gets or sets the style in which the text is rendered.

(Inherited from Control)

FontStyleProperty FontStyleProperty FontStyleProperty FontStyleProperty

Identifies the FontStyle dependency property.

(Inherited from Control)

FontWeight FontWeight FontWeight FontWeight

Gets or sets the thickness of the specified font.

(Inherited from Control)

FontWeightProperty FontWeightProperty FontWeightProperty FontWeightProperty

Identifies the FontWeight dependency property.

(Inherited from Control)

Foreground Foreground Foreground Foreground

Gets or sets a brush that describes the foreground color.

(Inherited from Control)

ForegroundProperty ForegroundProperty ForegroundProperty ForegroundProperty

Identifies the Foreground dependency property.

(Inherited from Control)

GettingFocusEvent GettingFocusEvent GettingFocusEvent GettingFocusEvent

Gets the identifier for the GettingFocus routed event.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Height Height Height Height

Gets or sets the suggested height of a FrameworkElement.

(Inherited from FrameworkElement)

HeightProperty HeightProperty HeightProperty HeightProperty

Identifies the Height dependency property.

(Inherited from FrameworkElement)

HighContrastAdjustment HighContrastAdjustment HighContrastAdjustment HighContrastAdjustment

Gets or sets a value that indicates whether the framework automatically adjusts the element's visual properties when high contrast themes are enabled.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

HighContrastAdjustmentProperty HighContrastAdjustmentProperty HighContrastAdjustmentProperty HighContrastAdjustmentProperty

Identifies the HighContrastAdjustment dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

HoldingEvent HoldingEvent HoldingEvent HoldingEvent

Gets the identifier for the Holding routed event.

(Inherited from UIElement)

HorizontalAlignment HorizontalAlignment HorizontalAlignment HorizontalAlignment

Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control.

(Inherited from FrameworkElement)

HorizontalAlignmentProperty HorizontalAlignmentProperty HorizontalAlignmentProperty HorizontalAlignmentProperty

Identifies the HorizontalAlignment dependency property.

(Inherited from FrameworkElement)

HorizontalContentAlignment HorizontalContentAlignment HorizontalContentAlignment HorizontalContentAlignment

Gets or sets the horizontal alignment of the control's content.

(Inherited from Control)

HorizontalContentAlignmentProperty HorizontalContentAlignmentProperty HorizontalContentAlignmentProperty HorizontalContentAlignmentProperty

Identifies the HorizontalContentAlignment dependency property.

(Inherited from Control)

HorizontalOffset HorizontalOffset HorizontalOffset HorizontalOffset

Gets the distance the content has been scrolled horizontally.

public : double HorizontalOffset { get; }
double HorizontalOffset();
public double HorizontalOffset { get; }
Public ReadOnly Property HorizontalOffset As double
Value
double double

The distance the content has been scrolled horizontally.

See Also

HorizontalOffsetProperty HorizontalOffsetProperty HorizontalOffsetProperty HorizontalOffsetProperty

Identifies the HorizontalOffset dependency property.

public : static DependencyProperty HorizontalOffsetProperty { get; }
static DependencyProperty HorizontalOffsetProperty();
public static DependencyProperty HorizontalOffsetProperty { get; }
Public Static ReadOnly Property HorizontalOffsetProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the HorizontalOffset dependency property.

HorizontalScrollBarVisibility HorizontalScrollBarVisibility HorizontalScrollBarVisibility HorizontalScrollBarVisibility

Gets or sets a value that indicates whether a horizontal ScrollBar should be displayed.

public : ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }
ScrollBarVisibility HorizontalScrollBarVisibility(); void HorizontalScrollBarVisibility(ScrollBarVisibility horizontalscrollbarvisibility);
public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }
Public ReadWrite Property HorizontalScrollBarVisibility As ScrollBarVisibility
<ScrollViewer HorizontalScrollBarVisibility="scrollBarVisibilityMemberName"/>
-or-
<object ScrollViewer.HorizontalScrollBarVisibility="scrollBarVisibilityMemberName"/>
Value
ScrollBarVisibility ScrollBarVisibility

A ScrollBarVisibility value that indicates whether a horizontal ScrollBar should be displayed. The default value is Disabled.

Remarks

For XAML usage, HorizontalScrollBarVisibility can either be an attribute on an explicit ScrollViewer element, or a ScrollViewer.HorizontalScrollBarVisibility attached property usage on an element that is a child of a control that supports scrollview implicitly in its template. Controls with a ScrollViewer as part of their composition typically use template binding such that setting the attached property at the level of the control will change the scroll behavior of the ScrollViewer part within the control. Otherwise, it may be necessary to replace the template in order to change the scroll behavior of a ScrollViewer part.

HorizontalScrollBarVisibilityProperty HorizontalScrollBarVisibilityProperty HorizontalScrollBarVisibilityProperty HorizontalScrollBarVisibilityProperty

Identifies the HorizontalScrollBarVisibility dependency property.

public : static DependencyProperty HorizontalScrollBarVisibilityProperty { get; }
static DependencyProperty HorizontalScrollBarVisibilityProperty();
public static DependencyProperty HorizontalScrollBarVisibilityProperty { get; }
Public Static ReadOnly Property HorizontalScrollBarVisibilityProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the HorizontalScrollBarVisibility dependency property.

HorizontalScrollMode HorizontalScrollMode HorizontalScrollMode HorizontalScrollMode

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

public : ScrollMode HorizontalScrollMode { get; set; }
ScrollMode HorizontalScrollMode(); void HorizontalScrollMode(ScrollMode horizontalscrollmode);
public ScrollMode HorizontalScrollMode { get; set; }
Public ReadWrite Property HorizontalScrollMode As ScrollMode
<ScrollViewer HorizontalScrollMode="scrollModeMemberName" />
-or-
<object ScrollViewer.HorizontalScrollMode="scrollModeMemberName"/>
Value
ScrollMode ScrollMode

A value of the enumeration. The typical default (as set through the default template, not class initialization) is Enabled.

Remarks

Scrolling behavior can also be set through a ScrollViewer.HorizontalScrollMode XAML attached property usage, or by calling SetHorizontalScrollMode. This is 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. Controls with a ScrollViewer as part of their composition typically use template binding such that setting the attached property at the level of the control will change the scroll behavior of the ScrollViewer part within the control. Otherwise, it may be necessary to replace the template in order to change the scroll behavior of a ScrollViewer part.

HorizontalScrollModeProperty HorizontalScrollModeProperty HorizontalScrollModeProperty HorizontalScrollModeProperty

Identifies the HorizontalScrollMode dependency property.

public : static DependencyProperty HorizontalScrollModeProperty { get; }
static DependencyProperty HorizontalScrollModeProperty();
public static DependencyProperty HorizontalScrollModeProperty { get; }
Public Static ReadOnly Property HorizontalScrollModeProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the HorizontalScrollMode dependency property.

HorizontalSnapPointsAlignment HorizontalSnapPointsAlignment HorizontalSnapPointsAlignment HorizontalSnapPointsAlignment

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

public : SnapPointsAlignment HorizontalSnapPointsAlignment { get; set; }
SnapPointsAlignment HorizontalSnapPointsAlignment(); void HorizontalSnapPointsAlignment(SnapPointsAlignment horizontalsnappointsalignment);
public SnapPointsAlignment HorizontalSnapPointsAlignment { get; set; }
Public ReadWrite Property HorizontalSnapPointsAlignment As SnapPointsAlignment
<ScrollViewer HorizontalSnapPointsAlignment="snapPointsAlignmentMemberName" />
Value
SnapPointsAlignment SnapPointsAlignment

A value of the enumeration.

HorizontalSnapPointsAlignmentProperty HorizontalSnapPointsAlignmentProperty HorizontalSnapPointsAlignmentProperty HorizontalSnapPointsAlignmentProperty

Identifies the HorizontalSnapPointsAlignment dependency property.

public : static DependencyProperty HorizontalSnapPointsAlignmentProperty { get; }
static DependencyProperty HorizontalSnapPointsAlignmentProperty();
public static DependencyProperty HorizontalSnapPointsAlignmentProperty { get; }
Public Static ReadOnly Property HorizontalSnapPointsAlignmentProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the HorizontalSnapPointsAlignment dependency property.

HorizontalSnapPointsType HorizontalSnapPointsType HorizontalSnapPointsType HorizontalSnapPointsType

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

public : SnapPointsType HorizontalSnapPointsType { get; set; }
SnapPointsType HorizontalSnapPointsType(); void HorizontalSnapPointsType(SnapPointsType horizontalsnappointstype);
public SnapPointsType HorizontalSnapPointsType { get; set; }
Public ReadWrite Property HorizontalSnapPointsType As SnapPointsType
<ScrollViewer HorizontalSnapPointsType="snapPointsTypeMemberName" />
Value
SnapPointsType SnapPointsType

A value of the enumeration. The default is None but might be set through a control template.

Examples

This XAML is from the default template for a Hub control. A Hub has a ScrollViewer part that surrounds an ItemsStackPanel for its content. Hub uses the Optional value for its snapping behavior in both dimensions (although VerticalScrollMode is disabled in starting visual states) and disables ZoomMode. Note how the SnapPointsAlignment properties are also set as attributes here.


<ControlTemplate TargetType="Hub">
...
<ScrollViewer x:Name="ScrollViewer"
    Grid.RowSpan="2"
    HorizontalScrollMode="Auto"
    HorizontalScrollBarVisibility="Auto"
    VerticalScrollMode="Disabled"
    VerticalScrollBarVisibility="Disabled"
    HorizontalSnapPointsAlignment="Near"
    HorizontalSnapPointsType="Optional"
    VerticalSnapPointsAlignment="Near"
    VerticalSnapPointsType="Optional"
    ZoomMode="Disabled">
  <ItemsStackPanel x:Name="Panel" 
       Orientation="{TemplateBinding Orientation}"
       CacheLength="20" />
</ScrollViewer>
...
</ControlTemplate>

Remarks

For panning actions, there are often natural stopping places. Snap points provide a way to indicate where these places are. Then, when a user swipes, the manipulation result favors that natural point using behavior as expressed by a SnapPointsType value.

Proximity points (Optional** and *OptionalSingle*): ** When a user is going to naturally stop the manipulation in the proximity of a snap point, proximity points help the user land at the natural stopping place. Because the user has to land in proximity to the snap point to cause it to stop there, the user will sometimes have to perform another swipe to reach a snap point.

Mandatory snap points (Mandatory** and *MandatorySingle*): ** In contrast to proximity, mandatory snap points ensure that the content is adjusted to always land on a snap point. Even if the user releases the manipulation halfway between two snap-points, it will always move to one of the snap points.

To see the effects of snap points on ScrollViewer behavior yourself, get the XAML scrolling, panning and zooming sample. Run the sample on a touch device (not the simulator). Try out the SnapPointsType values when you view the "Panning with snap-points" example page of the sample.

To learn more about the swipe gesture and panning, see the "Panning behaviors" section of Guidelines for panning.

The default value of None is the default of the enumeration. If it's set, this property is often set as an attribute in a XAML template part, or as a style Setter. Each control potentially sets this differently. Getting the value at run time will provide the value that came from applied styles and templates.

See Also

HorizontalSnapPointsTypeProperty HorizontalSnapPointsTypeProperty HorizontalSnapPointsTypeProperty HorizontalSnapPointsTypeProperty

Identifies the HorizontalSnapPointsType dependency property.

public : static DependencyProperty HorizontalSnapPointsTypeProperty { get; }
static DependencyProperty HorizontalSnapPointsTypeProperty();
public static DependencyProperty HorizontalSnapPointsTypeProperty { get; }
Public Static ReadOnly Property HorizontalSnapPointsTypeProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the HorizontalSnapPointsType dependency property.

IsAccessKeyScope IsAccessKeyScope IsAccessKeyScope IsAccessKeyScope

Gets or sets a value that indicates whether an element defines its own access key scope.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

IsAccessKeyScopeProperty IsAccessKeyScopeProperty IsAccessKeyScopeProperty IsAccessKeyScopeProperty

Identifies for the IsAccessKeyScope dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

IsDeferredScrollingEnabled IsDeferredScrollingEnabled IsDeferredScrollingEnabled IsDeferredScrollingEnabled

Gets or sets a value that determines the deferred scrolling behavior for a ScrollViewer.

public : Platform::Boolean IsDeferredScrollingEnabled { get; set; }
bool IsDeferredScrollingEnabled(); void IsDeferredScrollingEnabled(bool isdeferredscrollingenabled);
public bool IsDeferredScrollingEnabled { get; set; }
Public ReadWrite Property IsDeferredScrollingEnabled As bool
<ScrollViewer IsDeferredScrollingEnabled="bool" />
-or-
<object ScrollViewer.IsDeferredScrollingEnabled="bool"/>
Value
bool bool

true if deferred scrolling should occur; otherwise, false.

Remarks

Deferred scrolling behavior means that the view does not scroll until a user action is completed. For example, if a region scrolls when the user manipulates a thumb control, and IsDeferredScrollingEnabled is true, the scroll does not occur until the touch point on the thumb is released. In contrast, if IsDeferredScrollingEnabled is false, the region scrolls any time that the touch point selection point along the slider track is moved.

For XAML usage, IsDeferredScrollingEnabled can either be an attribute on an explicit ScrollViewer element, or a ScrollViewer.IsDeferredScrollingEnabled attached property usage on an element that is a child of a control that supports scrollview implicitly in its template.

IsDeferredScrollingEnabledProperty IsDeferredScrollingEnabledProperty IsDeferredScrollingEnabledProperty IsDeferredScrollingEnabledProperty

Identifies the IsDeferredScrollingEnabled dependency property.

public : static DependencyProperty IsDeferredScrollingEnabledProperty { get; }
static DependencyProperty IsDeferredScrollingEnabledProperty();
public static DependencyProperty IsDeferredScrollingEnabledProperty { get; }
Public Static ReadOnly Property IsDeferredScrollingEnabledProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the IsDeferredScrollingEnabled dependency property.

IsDoubleTapEnabled IsDoubleTapEnabled IsDoubleTapEnabled IsDoubleTapEnabled

Gets or sets a value that determines whether the DoubleTapped event can originate from that element.

(Inherited from UIElement)

IsDoubleTapEnabledProperty IsDoubleTapEnabledProperty IsDoubleTapEnabledProperty IsDoubleTapEnabledProperty

Identifies the IsDoubleTapEnabled dependency property.

(Inherited from UIElement)

IsEnabled IsEnabled IsEnabled IsEnabled

Gets or sets a value indicating whether the user can interact with the control.

(Inherited from Control)

IsEnabledProperty IsEnabledProperty IsEnabledProperty IsEnabledProperty

Identifies the IsEnabled dependency property.

(Inherited from Control)

IsFocusEngaged IsFocusEngaged IsFocusEngaged IsFocusEngaged

Get or sets a value that indicates whether focus is constrained within the control boundaries (for game pad/remote interaction).

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

IsFocusEngagedProperty IsFocusEngagedProperty IsFocusEngagedProperty IsFocusEngagedProperty

Identifies the IsFocusEngaged dependency property.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

IsFocusEngagementEnabled IsFocusEngagementEnabled IsFocusEngagementEnabled IsFocusEngagementEnabled

Get or sets a value that indicates whether focus can be constrained within the control boundaries (for game pad/remote interaction).

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

IsFocusEngagementEnabledProperty IsFocusEngagementEnabledProperty IsFocusEngagementEnabledProperty IsFocusEngagementEnabledProperty

Identifies the IsFocusEngagementEnabled dependency property.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

IsHitTestVisible IsHitTestVisible IsHitTestVisible IsHitTestVisible

Gets or sets whether the contained area of this UIElement can return true values for hit testing.

(Inherited from UIElement)

IsHitTestVisibleProperty IsHitTestVisibleProperty IsHitTestVisibleProperty IsHitTestVisibleProperty

Identifies the IsHitTestVisible dependency property.

(Inherited from UIElement)

IsHoldingEnabled IsHoldingEnabled IsHoldingEnabled IsHoldingEnabled

Gets or sets a value that determines whether the Holding event can originate from that element.

(Inherited from UIElement)

IsHoldingEnabledProperty IsHoldingEnabledProperty IsHoldingEnabledProperty IsHoldingEnabledProperty

Identifies the IsHoldingEnabled dependency property.

(Inherited from UIElement)

IsHorizontalRailEnabled IsHorizontalRailEnabled IsHorizontalRailEnabled IsHorizontalRailEnabled

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

public : Platform::Boolean IsHorizontalRailEnabled { get; set; }
bool IsHorizontalRailEnabled(); void IsHorizontalRailEnabled(bool ishorizontalrailenabled);
public bool IsHorizontalRailEnabled { get; set; }
Public ReadWrite Property IsHorizontalRailEnabled As bool
<ScrollViewer IsHorizontalRailEnabled="bool" />
-or-
<object ScrollViewer.IsHorizontalRailEnabled="bool"/>
Value
bool bool

True to enable the horizontal scroll rail; otherwise, false. The default is true.

IsHorizontalRailEnabledProperty IsHorizontalRailEnabledProperty IsHorizontalRailEnabledProperty IsHorizontalRailEnabledProperty

Identifies the IsHorizontalRailEnabled dependency property.

public : static DependencyProperty IsHorizontalRailEnabledProperty { get; }
static DependencyProperty IsHorizontalRailEnabledProperty();
public static DependencyProperty IsHorizontalRailEnabledProperty { get; }
Public Static ReadOnly Property IsHorizontalRailEnabledProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the IsHorizontalRailEnabled dependency property.

IsHorizontalScrollChainingEnabled IsHorizontalScrollChainingEnabled IsHorizontalScrollChainingEnabled IsHorizontalScrollChainingEnabled

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

public : Platform::Boolean IsHorizontalScrollChainingEnabled { get; set; }
bool IsHorizontalScrollChainingEnabled(); void IsHorizontalScrollChainingEnabled(bool ishorizontalscrollchainingenabled);
public bool IsHorizontalScrollChainingEnabled { get; set; }
Public ReadWrite Property IsHorizontalScrollChainingEnabled As bool
<ScrollViewer IsHorizontalScrollChainingEnabled="bool" />
-or-
<object ScrollViewer.IsHorizontalScrollChainingEnabled="bool"/>

Value
bool bool

true to enable horizontal scroll chaining from child to parent; otherwise, false.

Remarks

For XAML usage, IsHorizontalScrollChainingEnabled can either be an attribute on an explicit ScrollViewer element, or a ScrollViewer.IsHorizontalScrollChainingEnabled attached property usage on an element that is a child of a control that supports scrollview implicitly in its template.

IsHorizontalScrollChainingEnabledProperty IsHorizontalScrollChainingEnabledProperty IsHorizontalScrollChainingEnabledProperty IsHorizontalScrollChainingEnabledProperty

Identifies the IsHorizontalScrollChainingEnabled dependency property.

public : static DependencyProperty IsHorizontalScrollChainingEnabledProperty { get; }
static DependencyProperty IsHorizontalScrollChainingEnabledProperty();
public static DependencyProperty IsHorizontalScrollChainingEnabledProperty { get; }
Public Static ReadOnly Property IsHorizontalScrollChainingEnabledProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the IsHorizontalScrollChainingEnabled dependency property.

IsRightTapEnabled IsRightTapEnabled IsRightTapEnabled IsRightTapEnabled

Gets or sets a value that determines whether the RightTapped event can originate from that element.

(Inherited from UIElement)

IsRightTapEnabledProperty IsRightTapEnabledProperty IsRightTapEnabledProperty IsRightTapEnabledProperty

Identifies the IsRightTapEnabled dependency property.

(Inherited from UIElement)

IsScrollInertiaEnabled IsScrollInertiaEnabled IsScrollInertiaEnabled IsScrollInertiaEnabled

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

public : Platform::Boolean IsScrollInertiaEnabled { get; set; }
bool IsScrollInertiaEnabled(); void IsScrollInertiaEnabled(bool isscrollinertiaenabled);
public bool IsScrollInertiaEnabled { get; set; }
Public ReadWrite Property IsScrollInertiaEnabled As bool
<ScrollViewer IsScrollInertiaEnabled="bool" />
-or-
<object ScrollViewer.IsScrollInertiaEnabled="bool"/>
Value
bool bool

true if scroll actions should include inertia in their behavior and value; otherwise, false.

Remarks

For XAML usage, IsScrollInertiaEnabled can either be an attribute on an explicit ScrollViewer element, or a ScrollViewer.IsScrollInertiaEnabled attached property usage on an element that is a child of a control that supports scrollview implicitly in its template.

IsScrollInertiaEnabledProperty IsScrollInertiaEnabledProperty IsScrollInertiaEnabledProperty IsScrollInertiaEnabledProperty

Identifies the IsScrollInertiaEnabled dependency property.

public : static DependencyProperty IsScrollInertiaEnabledProperty { get; }
static DependencyProperty IsScrollInertiaEnabledProperty();
public static DependencyProperty IsScrollInertiaEnabledProperty { get; }
Public Static ReadOnly Property IsScrollInertiaEnabledProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the IsScrollInertiaEnabled dependency property.

IsTabStop IsTabStop IsTabStop IsTabStop

Gets or sets a value that indicates whether a control is included in tab navigation.

(Inherited from Control)

IsTabStopProperty IsTabStopProperty IsTabStopProperty IsTabStopProperty

Identifies the IsTabStop dependency property.

(Inherited from Control)

IsTapEnabled IsTapEnabled IsTapEnabled IsTapEnabled

Gets or sets a value that determines whether the Tapped event can originate from that element.

(Inherited from UIElement)

IsTapEnabledProperty IsTapEnabledProperty IsTapEnabledProperty IsTapEnabledProperty

Identifies the IsTapEnabled dependency property.

(Inherited from UIElement)

IsTemplateFocusTargetProperty IsTemplateFocusTargetProperty IsTemplateFocusTargetProperty IsTemplateFocusTargetProperty

Identifies the Control.IsTemplateFocusTarget XAML attached property.

(Inherited from Control)

IsTemplateKeyTipTargetProperty IsTemplateKeyTipTargetProperty IsTemplateKeyTipTargetProperty IsTemplateKeyTipTargetProperty

Identifies the Control.IsTemplateKeyTipTarget XAML attached property.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

IsTextScaleFactorEnabled IsTextScaleFactorEnabled IsTextScaleFactorEnabled IsTextScaleFactorEnabled

Gets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled.

(Inherited from Control)

IsTextScaleFactorEnabledProperty IsTextScaleFactorEnabledProperty IsTextScaleFactorEnabledProperty IsTextScaleFactorEnabledProperty

Identifies the IsTextScaleFactorEnabled dependency property.

(Inherited from Control)

IsVerticalRailEnabled IsVerticalRailEnabled IsVerticalRailEnabled IsVerticalRailEnabled

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

public : Platform::Boolean IsVerticalRailEnabled { get; set; }
bool IsVerticalRailEnabled(); void IsVerticalRailEnabled(bool isverticalrailenabled);
public bool IsVerticalRailEnabled { get; set; }
Public ReadWrite Property IsVerticalRailEnabled As bool
<ScrollViewer IsVerticalRailEnabled="bool" />
-or-
<object ScrollViewer.IsVerticalRailEnabled="bool"/>
Value
bool bool

True to enable the vertical scroll rail; otherwise, false. The default is true.

IsVerticalRailEnabledProperty IsVerticalRailEnabledProperty IsVerticalRailEnabledProperty IsVerticalRailEnabledProperty

Identifies the IsVerticalRailEnabled dependency property.

public : static DependencyProperty IsVerticalRailEnabledProperty { get; }
static DependencyProperty IsVerticalRailEnabledProperty();
public static DependencyProperty IsVerticalRailEnabledProperty { get; }
Public Static ReadOnly Property IsVerticalRailEnabledProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the IsVerticalRailEnabled dependency property.

IsVerticalScrollChainingEnabled IsVerticalScrollChainingEnabled IsVerticalScrollChainingEnabled IsVerticalScrollChainingEnabled

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

public : Platform::Boolean IsVerticalScrollChainingEnabled { get; set; }
bool IsVerticalScrollChainingEnabled(); void IsVerticalScrollChainingEnabled(bool isverticalscrollchainingenabled);
public bool IsVerticalScrollChainingEnabled { get; set; }
Public ReadWrite Property IsVerticalScrollChainingEnabled As bool
<ScrollViewer IsVerticalScrollChainingEnabled="bool" />
-or-
<object ScrollViewer.IsVerticalScrollChainingEnabled="bool"/>
Value
bool bool

true to enable vertical scroll chaining from child to parent; otherwise, false.

Remarks

For XAML usage, IsVerticalScrollChainingEnabled can either be an attribute on an explicit ScrollViewer element, or a ScrollViewer.IsVerticalScrollChainingEnabled attached property usage on an element that is a child of a control that supports scrollview implicitly in its template.

IsVerticalScrollChainingEnabledProperty IsVerticalScrollChainingEnabledProperty IsVerticalScrollChainingEnabledProperty IsVerticalScrollChainingEnabledProperty

Identifies the IsVerticalScrollChainingEnabled dependency property.

public : static DependencyProperty IsVerticalScrollChainingEnabledProperty { get; }
static DependencyProperty IsVerticalScrollChainingEnabledProperty();
public static DependencyProperty IsVerticalScrollChainingEnabledProperty { get; }
Public Static ReadOnly Property IsVerticalScrollChainingEnabledProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the IsVerticalScrollChainingEnabled dependency property.

IsZoomChainingEnabled IsZoomChainingEnabled IsZoomChainingEnabled IsZoomChainingEnabled

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

public : Platform::Boolean IsZoomChainingEnabled { get; set; }
bool IsZoomChainingEnabled(); void IsZoomChainingEnabled(bool iszoomchainingenabled);
public bool IsZoomChainingEnabled { get; set; }
Public ReadWrite Property IsZoomChainingEnabled As bool
<ScrollViewer IsZoomChainingEnabled="bool" />
-or-
<object ScrollViewer.IsZoomChainingEnabled="bool"/>
Value
bool bool

true to enable zoom chaining from child to parent; otherwise, false.

Remarks

For XAML usage, IsZoomChainingEnabled can either be an attribute on an explicit ScrollViewer element, or a ScrollViewer.IsZoomChainingEnabled attached property usage on an element that is a child of a control that supports scrollview implicitly in its template.

IsZoomChainingEnabledProperty IsZoomChainingEnabledProperty IsZoomChainingEnabledProperty IsZoomChainingEnabledProperty

Identifies the IsZoomChainingEnabled dependency property.

public : static DependencyProperty IsZoomChainingEnabledProperty { get; }
static DependencyProperty IsZoomChainingEnabledProperty();
public static DependencyProperty IsZoomChainingEnabledProperty { get; }
Public Static ReadOnly Property IsZoomChainingEnabledProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the IsZoomChainingEnabled dependency property.

IsZoomInertiaEnabled IsZoomInertiaEnabled IsZoomInertiaEnabled IsZoomInertiaEnabled

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

public : Platform::Boolean IsZoomInertiaEnabled { get; set; }
bool IsZoomInertiaEnabled(); void IsZoomInertiaEnabled(bool iszoominertiaenabled);
public bool IsZoomInertiaEnabled { get; set; }
Public ReadWrite Property IsZoomInertiaEnabled As bool
<ScrollViewer IsZoomInertiaEnabled="bool" />
-or-
<object ScrollViewer.IsZoomInertiaEnabled="bool"/>
Value
bool bool

true if zoom actions should include inertia in their behavior and value; otherwise, false.

Remarks

For XAML usage, IsZoomInertiaEnabled can either be an attribute on an explicit ScrollViewer element, or a ScrollViewer.IsZoomInertiaEnabled attached property usage on an element that is a child of a control that supports scrollview implicitly in its template.

IsZoomInertiaEnabledProperty IsZoomInertiaEnabledProperty IsZoomInertiaEnabledProperty IsZoomInertiaEnabledProperty

Identifies the IsZoomInertiaEnabled dependency property.

public : static DependencyProperty IsZoomInertiaEnabledProperty { get; }
static DependencyProperty IsZoomInertiaEnabledProperty();
public static DependencyProperty IsZoomInertiaEnabledProperty { get; }
Public Static ReadOnly Property IsZoomInertiaEnabledProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the IsZoomInertiaEnabled dependency property.

KeyDownEvent KeyDownEvent KeyDownEvent KeyDownEvent

Gets the identifier for the KeyDown routed event.

(Inherited from UIElement)

KeyTipHorizontalOffset KeyTipHorizontalOffset KeyTipHorizontalOffset KeyTipHorizontalOffset

Gets or sets a value that indicates how far left or right the Key Tip is placed in relation to the UIElement.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

KeyTipHorizontalOffsetProperty KeyTipHorizontalOffsetProperty KeyTipHorizontalOffsetProperty KeyTipHorizontalOffsetProperty

Identifies the KeyTipHorizontalOffset dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

KeyTipPlacementMode KeyTipPlacementMode KeyTipPlacementMode KeyTipPlacementMode

Gets or sets a value that indicates where the access key Key Tip is placed in relation to the boundary of the UIElement.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

KeyTipPlacementModeProperty KeyTipPlacementModeProperty KeyTipPlacementModeProperty KeyTipPlacementModeProperty

Identifies the KeyTipPlacementMode dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

KeyTipTarget KeyTipTarget KeyTipTarget KeyTipTarget

Prerelease. Gets or sets a value that indicates the element targeted by the access key Key Tip.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.17095.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v6)

KeyTipTargetProperty KeyTipTargetProperty KeyTipTargetProperty KeyTipTargetProperty

Prerelease. Identifies the KeyTipTarget dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.17095.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v6)

KeyTipVerticalOffset KeyTipVerticalOffset KeyTipVerticalOffset KeyTipVerticalOffset

Gets or sets a value that indicates how far up or down the Key Tip is placed in relation to the UI element.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

KeyTipVerticalOffsetProperty KeyTipVerticalOffsetProperty KeyTipVerticalOffsetProperty KeyTipVerticalOffsetProperty

Identifies the KeyTipVerticalOffset dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

KeyUpEvent KeyUpEvent KeyUpEvent KeyUpEvent

Gets the identifier for the KeyUp routed event.

(Inherited from UIElement)

KeyboardAcceleratorPlacementMode KeyboardAcceleratorPlacementMode KeyboardAcceleratorPlacementMode KeyboardAcceleratorPlacementMode

Prerelease. Gets or sets a value that indicates whether the control tooltip displays the key combination for it's associated keyboard accelerator.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.17095.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v6)

KeyboardAcceleratorPlacementModeProperty KeyboardAcceleratorPlacementModeProperty KeyboardAcceleratorPlacementModeProperty KeyboardAcceleratorPlacementModeProperty

Prerelease. Identifies the KeyboardAcceleratorPlacementMode dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.17095.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v6)

KeyboardAcceleratorPlacementTarget KeyboardAcceleratorPlacementTarget KeyboardAcceleratorPlacementTarget KeyboardAcceleratorPlacementTarget

Prerelease. Gets or sets a value that indicates the control tooltip that displays the accelerator key combination.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.17095.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v6)

KeyboardAcceleratorPlacementTargetProperty KeyboardAcceleratorPlacementTargetProperty KeyboardAcceleratorPlacementTargetProperty KeyboardAcceleratorPlacementTargetProperty

Prerelease. Identifies the KeyboardAcceleratorPlacementTarget dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.17095.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v6)

KeyboardAccelerators KeyboardAccelerators KeyboardAccelerators KeyboardAccelerators

Gets the the collection of key combinations that invoke an action using the keyboard.

Accelerators are typically assigned to buttons or menu items.

Example of a menu showing keyboard accelerators for various menu items
Example of a menu showing keyboard accelerators for various menu items

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Language Language Language Language

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)

LanguageProperty LanguageProperty LanguageProperty LanguageProperty

Identifies the Language dependency property.

(Inherited from FrameworkElement)

LeftHeader LeftHeader LeftHeader LeftHeader

Gets or sets the content of the left header.

public : UIElement LeftHeader { get; set; }
UIElement LeftHeader(); void LeftHeader(UIElement leftheader);
public UIElement LeftHeader { get; set; }
Public ReadWrite Property LeftHeader As UIElement
<ScrollViewer>
  <ScrollViewer.LeftHeader>headerObject</ScrollViewer.LeftHeader>
</ScrollViewer>

Value
UIElement UIElement

The content of the left header.

Remarks

The LeftHeader, TopHeader, and TopLeftHeader properties can be set only when ScrollViewer content's HorizontalAlignment is Left and VerticalAlignment is Top.

The left header scrolls vertically, but not horizontally.

See Also

LeftHeaderProperty LeftHeaderProperty LeftHeaderProperty LeftHeaderProperty

Identifies the LeftHeader dependency property.

public : static DependencyProperty LeftHeaderProperty { get; }
static DependencyProperty LeftHeaderProperty();
public static DependencyProperty LeftHeaderProperty { get; }
Public Static ReadOnly Property LeftHeaderProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the LeftHeader dependency property.

Lights Lights Lights Lights

Gets the collection of XamlLight objects attached to this element.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

LightsProperty LightsProperty LightsProperty LightsProperty

Identifies the Lights dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

LosingFocusEvent LosingFocusEvent LosingFocusEvent LosingFocusEvent

Gets the identifier for the LosingFocus routed event.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

ManipulationCompletedEvent ManipulationCompletedEvent ManipulationCompletedEvent ManipulationCompletedEvent

Gets the identifier for the ManipulationCompleted routed event.

(Inherited from UIElement)

ManipulationDeltaEvent ManipulationDeltaEvent ManipulationDeltaEvent ManipulationDeltaEvent

Gets the identifier for the ManipulationDelta routed event.

(Inherited from UIElement)

ManipulationInertiaStartingEvent ManipulationInertiaStartingEvent ManipulationInertiaStartingEvent ManipulationInertiaStartingEvent

Gets the identifier for the ManipulationInertiaStarting routed event.

(Inherited from UIElement)

ManipulationMode ManipulationMode ManipulationMode ManipulationMode

Gets 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)

ManipulationModeProperty ManipulationModeProperty ManipulationModeProperty ManipulationModeProperty

Identifies the ManipulationMode dependency property.

(Inherited from UIElement)

ManipulationStartedEvent ManipulationStartedEvent ManipulationStartedEvent ManipulationStartedEvent

Gets the identifier for the ManipulationStarted routed event.

(Inherited from UIElement)

ManipulationStartingEvent ManipulationStartingEvent ManipulationStartingEvent ManipulationStartingEvent

Gets the identifier for the ManipulationStarting routed event.

(Inherited from UIElement)

Margin Margin Margin Margin

Gets or sets the outer margin of a FrameworkElement.

(Inherited from FrameworkElement)

MarginProperty MarginProperty MarginProperty MarginProperty

Identifies the Margin dependency property.

(Inherited from FrameworkElement)

MaxHeight MaxHeight MaxHeight MaxHeight

Gets or sets the maximum height constraint of a FrameworkElement.

(Inherited from FrameworkElement)

MaxHeightProperty MaxHeightProperty MaxHeightProperty MaxHeightProperty

Identifies the MaxHeight dependency property.

(Inherited from FrameworkElement)

MaxWidth MaxWidth MaxWidth MaxWidth

Gets or sets the maximum width constraint of a FrameworkElement.

(Inherited from FrameworkElement)

MaxWidthProperty MaxWidthProperty MaxWidthProperty MaxWidthProperty

Identifies the MaxWidth dependency property.

(Inherited from FrameworkElement)

MaxZoomFactor MaxZoomFactor MaxZoomFactor MaxZoomFactor

Gets or sets a value that indicates the maximum permitted run-time value of ZoomFactor.

public : float MaxZoomFactor { get; set; }
float MaxZoomFactor(); void MaxZoomFactor(float maxzoomfactor);
public float MaxZoomFactor { get; set; }
Public ReadWrite Property MaxZoomFactor As float
<ScrollViewer MaxZoomFactor="single" />
Value
float float

The maximum permitted run-time value of ZoomFactor. The default is 10.

MaxZoomFactorProperty MaxZoomFactorProperty MaxZoomFactorProperty MaxZoomFactorProperty

Identifies the MaxZoomFactor dependency property.

public : static DependencyProperty MaxZoomFactorProperty { get; }
static DependencyProperty MaxZoomFactorProperty();
public static DependencyProperty MaxZoomFactorProperty { get; }
Public Static ReadOnly Property MaxZoomFactorProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the MaxZoomFactor dependency property.

MinHeight MinHeight MinHeight MinHeight

Gets or sets the minimum height constraint of a FrameworkElement.

(Inherited from FrameworkElement)

MinHeightProperty MinHeightProperty MinHeightProperty MinHeightProperty

Identifies the MinHeight dependency property.

(Inherited from FrameworkElement)

MinWidth MinWidth MinWidth MinWidth

Gets or sets the minimum width constraint of a FrameworkElement.

(Inherited from FrameworkElement)

MinWidthProperty MinWidthProperty MinWidthProperty MinWidthProperty

Identifies the MinWidth dependency property.

(Inherited from FrameworkElement)

MinZoomFactor MinZoomFactor MinZoomFactor MinZoomFactor

Gets or sets a value that indicates the minimum permitted run-time value of ZoomFactor.

public : float MinZoomFactor { get; set; }
float MinZoomFactor(); void MinZoomFactor(float minzoomfactor);
public float MinZoomFactor { get; set; }
Public ReadWrite Property MinZoomFactor As float
<ScrollViewer MinZoomFactor="single" />
Value
float float

The minimum permitted run-time value of ZoomFactor. The default is 0.1.

MinZoomFactorProperty MinZoomFactorProperty MinZoomFactorProperty MinZoomFactorProperty

Identifies the MinZoomFactor dependency property.

public : static DependencyProperty MinZoomFactorProperty { get; }
static DependencyProperty MinZoomFactorProperty();
public static DependencyProperty MinZoomFactorProperty { get; }
Public Static ReadOnly Property MinZoomFactorProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the MinZoomFactor dependency property.

Name Name Name Name

Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name.

(Inherited from FrameworkElement)

NameProperty NameProperty NameProperty NameProperty

Identifies the Name dependency property.

(Inherited from FrameworkElement)

NoFocusCandidateFoundEvent NoFocusCandidateFoundEvent NoFocusCandidateFoundEvent NoFocusCandidateFoundEvent

Gets the identifier for the NoFocusCandidateFound routed event.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Opacity Opacity Opacity Opacity

Gets or sets the degree of the object's opacity.

(Inherited from UIElement)

OpacityProperty OpacityProperty OpacityProperty OpacityProperty

Identifies the IsHitTestVisible dependency property.

(Inherited from UIElement)

Padding Padding Padding Padding

Gets or sets the padding inside a control.

(Inherited from Control)

PaddingProperty PaddingProperty PaddingProperty PaddingProperty

Identifies the Padding dependency property.

(Inherited from Control)

Parent Parent Parent Parent

Gets the parent object of this FrameworkElement in the object tree.

(Inherited from FrameworkElement)

PointerCanceledEvent PointerCanceledEvent PointerCanceledEvent PointerCanceledEvent

Gets the identifier for the PointerCanceled routed event.

(Inherited from UIElement)

PointerCaptureLostEvent PointerCaptureLostEvent PointerCaptureLostEvent PointerCaptureLostEvent

Gets the identifier for the PointerCaptureLost routed event.

(Inherited from UIElement)

PointerCaptures PointerCaptures PointerCaptures PointerCaptures

Gets the set of all captured pointers, represented as Pointer values.

(Inherited from UIElement)

PointerCapturesProperty PointerCapturesProperty PointerCapturesProperty PointerCapturesProperty

Identifies the PointerCaptures dependency property.

(Inherited from UIElement)

PointerEnteredEvent PointerEnteredEvent PointerEnteredEvent PointerEnteredEvent

Gets the identifier for the PointerEntered routed event.

(Inherited from UIElement)

PointerExitedEvent PointerExitedEvent PointerExitedEvent PointerExitedEvent

Gets the identifier for the PointerExited routed event.

(Inherited from UIElement)

PointerMovedEvent PointerMovedEvent PointerMovedEvent PointerMovedEvent

Gets the identifier for the PointerMoved routed event.

(Inherited from UIElement)

PointerPressedEvent PointerPressedEvent PointerPressedEvent PointerPressedEvent

Gets the identifier for the PointerPressed routed event.

(Inherited from UIElement)

PointerReleasedEvent PointerReleasedEvent PointerReleasedEvent PointerReleasedEvent

Gets the identifier for the PointerReleased routed event.

(Inherited from UIElement)

PointerWheelChangedEvent PointerWheelChangedEvent PointerWheelChangedEvent PointerWheelChangedEvent

Gets the identifier for the PointerWheelChanged routed event.

(Inherited from UIElement)

PreviewKeyDownEvent PreviewKeyDownEvent PreviewKeyDownEvent PreviewKeyDownEvent

Gets the identifier for the PreviewKeyDown routed event.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

PreviewKeyUpEvent PreviewKeyUpEvent PreviewKeyUpEvent PreviewKeyUpEvent

Gets the identifier for the PreviewKeyUp routed event.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Projection Projection Projection Projection

Gets or sets the perspective projection (3-D effect) to apply when rendering this element.

(Inherited from UIElement)

ProjectionProperty ProjectionProperty ProjectionProperty ProjectionProperty

Identifies the Projection dependency property.

(Inherited from UIElement)

RenderSize RenderSize RenderSize RenderSize

Gets the final render size of a UIElement. Use is not recommended, see Remarks.

(Inherited from UIElement)

RenderTransform RenderTransform RenderTransform RenderTransform

Gets or sets transform information that affects the rendering position of a UIElement.

(Inherited from UIElement)

RenderTransformOrigin RenderTransformOrigin RenderTransformOrigin RenderTransformOrigin

Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement.

(Inherited from UIElement)

RenderTransformOriginProperty RenderTransformOriginProperty RenderTransformOriginProperty RenderTransformOriginProperty

Identifies the RenderTransformOrigin dependency property.

(Inherited from UIElement)

RenderTransformProperty RenderTransformProperty RenderTransformProperty RenderTransformProperty

Identifies the RenderTransform dependency property.

(Inherited from UIElement)

RequestedTheme RequestedTheme RequestedTheme RequestedTheme

Gets 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)

RequestedThemeProperty RequestedThemeProperty RequestedThemeProperty RequestedThemeProperty

Identifies the RequestedTheme dependency property.

(Inherited from FrameworkElement)

RequiresPointer RequiresPointer RequiresPointer RequiresPointer

Gets or sets whether a UI element supports mouse mode, which emulates pointer interaction experiences with non-pointer input devices such as an Xbox gamepad or remote control.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

RequiresPointerProperty RequiresPointerProperty RequiresPointerProperty RequiresPointerProperty

Identifies the RequiresPointer dependency property.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Resources Resources Resources Resources

Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax.

(Inherited from FrameworkElement)

RightTappedEvent RightTappedEvent RightTappedEvent RightTappedEvent

Gets the identifier for the RightTapped routed event.

(Inherited from UIElement)

ScrollableHeight ScrollableHeight ScrollableHeight ScrollableHeight

Gets a value that represents the vertical size of the area that can be scrolled; the difference between the height of the extent and the height of the viewport.

public : double ScrollableHeight { get; }
double ScrollableHeight();
public double ScrollableHeight { get; }
Public ReadOnly Property ScrollableHeight As double
Value
double double

The vertical size of the area that can be scrolled. This property has no default value.

ScrollableHeightProperty ScrollableHeightProperty ScrollableHeightProperty ScrollableHeightProperty

Identifies the ScrollableHeight dependency property.

public : static DependencyProperty ScrollableHeightProperty { get; }
static DependencyProperty ScrollableHeightProperty();
public static DependencyProperty ScrollableHeightProperty { get; }
Public Static ReadOnly Property ScrollableHeightProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the ScrollableHeight dependency property.

ScrollableWidth ScrollableWidth ScrollableWidth ScrollableWidth

Gets a value that represents the horizontal size of the area that can be scrolled; the difference between the width of the extent and the width of the viewport.

public : double ScrollableWidth { get; }
double ScrollableWidth();
public double ScrollableWidth { get; }
Public ReadOnly Property ScrollableWidth As double
Value
double double

The horizontal size of the area that can be scrolled. This property has no default value.

ScrollableWidthProperty ScrollableWidthProperty ScrollableWidthProperty ScrollableWidthProperty

Identifies the ScrollableWidth dependency property.

public : static DependencyProperty ScrollableWidthProperty { get; }
static DependencyProperty ScrollableWidthProperty();
public static DependencyProperty ScrollableWidthProperty { get; }
Public Static ReadOnly Property ScrollableWidthProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the ScrollableWidth dependency property.

Style Style Style Style

Gets or sets an instance Style that is applied for this object during layout and rendering.

(Inherited from FrameworkElement)

StyleProperty StyleProperty StyleProperty StyleProperty

Identifies the Style dependency property.

(Inherited from FrameworkElement)

TabFocusNavigation TabFocusNavigation TabFocusNavigation TabFocusNavigation

Gets or sets a value that modifies how tabbing and TabIndex work for this control.

Note

For Windows 10 Creators Update (build 10.0.15063) and newer, use this property of the UIElement base class instead of the TabNavigation property of a Control object.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

TabFocusNavigationProperty TabFocusNavigationProperty TabFocusNavigationProperty TabFocusNavigationProperty

Identifies the TabFocusNavigation dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

TabIndex TabIndex TabIndex TabIndex

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)

TabIndexProperty TabIndexProperty TabIndexProperty TabIndexProperty

Identifies the TabIndex dependency property.

(Inherited from Control)

TabNavigation TabNavigation TabNavigation TabNavigation

Gets or sets a value that modifies how tabbing and TabIndex work for this control.

Note

For Windows 10 Creators Update (build 10.0.15063) and newer, the TabFocusNavigation property is available on the UIElement base class to include objects in the tab sequence that do not use a ControlTemplate.

(Inherited from Control)

TabNavigationProperty TabNavigationProperty TabNavigationProperty TabNavigationProperty

Identifies the TabNavigation dependency property.

(Inherited from Control)

Tag Tag Tag Tag

Gets or sets an arbitrary object value that can be used to store custom information about this object.

(Inherited from FrameworkElement)

TagProperty TagProperty TagProperty TagProperty

Identifies the Tag dependency property.

(Inherited from FrameworkElement)

TappedEvent TappedEvent TappedEvent TappedEvent

Gets the identifier for the Tapped routed event.

(Inherited from UIElement)

Template Template Template Template

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)

TemplateProperty TemplateProperty TemplateProperty TemplateProperty

Identifies the Template dependency property.

(Inherited from Control)

TopHeader TopHeader TopHeader TopHeader

Gets or sets the content of the top header.

public : UIElement TopHeader { get; set; }
UIElement TopHeader(); void TopHeader(UIElement topheader);
public UIElement TopHeader { get; set; }
Public ReadWrite Property TopHeader As UIElement
<ScrollViewer>
  <ScrollViewer.TopHeader>headerObject</ScrollViewer.TopHeader>
</ScrollViewer>

Value
UIElement UIElement

The content of the top header.

Remarks

The LeftHeader, TopHeader, and TopLeftHeader properties can be set only when ScrollViewer content's HorizontalAlignment is Left and VerticalAlignment is Top.

The top header scrolls horizontally, but not vertically.

TopHeaderProperty TopHeaderProperty TopHeaderProperty TopHeaderProperty

Identifies the TopHeader dependency property.

public : static DependencyProperty TopHeaderProperty { get; }
static DependencyProperty TopHeaderProperty();
public static DependencyProperty TopHeaderProperty { get; }
Public Static ReadOnly Property TopHeaderProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the TopHeader dependency property.

TopLeftHeader TopLeftHeader TopLeftHeader TopLeftHeader

Gets or sets the content of the top, left header.

public : UIElement TopLeftHeader { get; set; }
UIElement TopLeftHeader(); void TopLeftHeader(UIElement topleftheader);
public UIElement TopLeftHeader { get; set; }
Public ReadWrite Property TopLeftHeader As UIElement
<ScrollViewer>
  <ScrollViewer.TopLeftHeader>headerObject</ScrollViewer.TopLeftHeader>
</ScrollViewer>

Value
UIElement UIElement

The content of the top, left header.

Remarks

The LeftHeader, TopHeader, and TopLeftHeader properties can be set only when ScrollViewer content's HorizontalAlignment is Left and VerticalAlignment is Top.

The top left header doesn't scroll in any direction.

TopLeftHeaderProperty TopLeftHeaderProperty TopLeftHeaderProperty TopLeftHeaderProperty

Identifies the TopLeftHeader dependency property.

public : static DependencyProperty TopLeftHeaderProperty { get; }
static DependencyProperty TopLeftHeaderProperty();
public static DependencyProperty TopLeftHeaderProperty { get; }
Public Static ReadOnly Property TopLeftHeaderProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the TopLeftHeader dependency property.

Transform3D Transform3D Transform3D Transform3D

Gets or sets the 3-D transform effect to apply when rendering this element.

(Inherited from UIElement)

Transform3DProperty Transform3DProperty Transform3DProperty Transform3DProperty

Identifies the Transform3D dependency property.

(Inherited from UIElement)

Transitions Transitions Transitions Transitions

Gets or sets the collection of Transition style elements that apply to a UIElement.

(Inherited from UIElement)

TransitionsProperty TransitionsProperty TransitionsProperty TransitionsProperty

Identifies the Transitions dependency property.

(Inherited from UIElement)

Triggers Triggers Triggers Triggers

Gets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. See Remarks.

(Inherited from FrameworkElement)

UseLayoutRounding UseLayoutRounding UseLayoutRounding UseLayoutRounding

Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels.

(Inherited from UIElement)

UseLayoutRoundingProperty UseLayoutRoundingProperty UseLayoutRoundingProperty UseLayoutRoundingProperty

Identifies the UseLayoutRounding dependency property.

(Inherited from UIElement)

UseSystemFocusVisuals UseSystemFocusVisuals UseSystemFocusVisuals UseSystemFocusVisuals

Gets or sets a value that indicates whether the control uses focus visuals that are drawn by the system or those defined in the control template.

(Inherited from Control)

UseSystemFocusVisualsProperty UseSystemFocusVisualsProperty UseSystemFocusVisualsProperty UseSystemFocusVisualsProperty

Identifies the UseSystemFocusVisuals dependency property.

(Inherited from Control)

VerticalAlignment VerticalAlignment VerticalAlignment VerticalAlignment

Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control.

(Inherited from FrameworkElement)

VerticalAlignmentProperty VerticalAlignmentProperty VerticalAlignmentProperty VerticalAlignmentProperty

Identifies the VerticalAlignment dependency property.

(Inherited from FrameworkElement)

VerticalContentAlignment VerticalContentAlignment VerticalContentAlignment VerticalContentAlignment

Gets or sets the vertical alignment of the control's content.

(Inherited from Control)

VerticalContentAlignmentProperty VerticalContentAlignmentProperty VerticalContentAlignmentProperty VerticalContentAlignmentProperty

Identifies the VerticalContentAlignment dependency property.

(Inherited from Control)

VerticalOffset VerticalOffset VerticalOffset VerticalOffset

Gets the distance the content has been scrolled vertically.

public : double VerticalOffset { get; }
double VerticalOffset();
public double VerticalOffset { get; }
Public ReadOnly Property VerticalOffset As double
Value
double double

The distance the content has been scrolled vertically.

See Also

VerticalOffsetProperty VerticalOffsetProperty VerticalOffsetProperty VerticalOffsetProperty

Identifies the VerticalOffset dependency property.

public : static DependencyProperty VerticalOffsetProperty { get; }
static DependencyProperty VerticalOffsetProperty();
public static DependencyProperty VerticalOffsetProperty { get; }
Public Static ReadOnly Property VerticalOffsetProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the VerticalOffset dependency property.

VerticalScrollBarVisibility VerticalScrollBarVisibility VerticalScrollBarVisibility VerticalScrollBarVisibility

Gets or sets a value that indicates whether a vertical ScrollBar should be displayed.

public : ScrollBarVisibility VerticalScrollBarVisibility { get; set; }
ScrollBarVisibility VerticalScrollBarVisibility(); void VerticalScrollBarVisibility(ScrollBarVisibility verticalscrollbarvisibility);
public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }
Public ReadWrite Property VerticalScrollBarVisibility As ScrollBarVisibility
<ScrollViewer VerticalScrollBarVisibility="scrollBarVisibilityMemberName"/>
-or-
<object ScrollViewer.VerticalScrollBarVisibility="scrollBarVisibilityMemberName"/>
Value
ScrollBarVisibility ScrollBarVisibility

A ScrollBarVisibility value that indicates whether a vertical ScrollBar should be displayed. The default value is Visible.

Remarks

Scrolling behavior can also be set through a ScrollViewer.VerticalScrollBarVisibility XAML attached property usage, or by calling SetVerticalScrollBarVisibility. This is 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. Controls with a ScrollViewer as part of their composition typically use template binding such that setting the attached property at the level of the control will change the scroll behavior of the ScrollViewer part within the control. Otherwise, it may be necessary to replace the template in order to change the scroll behavior of a ScrollViewer part.

VerticalScrollBarVisibilityProperty VerticalScrollBarVisibilityProperty VerticalScrollBarVisibilityProperty VerticalScrollBarVisibilityProperty

Identifies the VerticalScrollBarVisibility dependency property.

public : static DependencyProperty VerticalScrollBarVisibilityProperty { get; }
static DependencyProperty VerticalScrollBarVisibilityProperty();
public static DependencyProperty VerticalScrollBarVisibilityProperty { get; }
Public Static ReadOnly Property VerticalScrollBarVisibilityProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the VerticalScrollBarVisibility dependency property.

VerticalScrollMode VerticalScrollMode VerticalScrollMode VerticalScrollMode

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

public : ScrollMode VerticalScrollMode { get; set; }
ScrollMode VerticalScrollMode(); void VerticalScrollMode(ScrollMode verticalscrollmode);
public ScrollMode VerticalScrollMode { get; set; }
Public ReadWrite Property VerticalScrollMode As ScrollMode
<ScrollViewer VerticalScrollMode="scrollModeMemberName" />
-or-
<object ScrollViewer.VerticalScrollMode="scrollModeMemberName"/>
Value
ScrollMode ScrollMode

A value of the enumeration. The typical default (as set through the default template, not class initialization) is Enabled.

Remarks

Scrolling behavior can also be set through a ScrollViewer.VerticalScrollMode XAML attached property usage, or by calling SetVerticalScrollMode. This is 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. Controls with a ScrollViewer as part of their composition typically use template binding such that setting the attached property at the level of the control will change the scroll behavior of the ScrollViewer part within the control. Otherwise, it may be necessary to replace the template in order to change the scroll behavior of a ScrollViewer part.

VerticalScrollModeProperty VerticalScrollModeProperty VerticalScrollModeProperty VerticalScrollModeProperty

Identifies the VerticalScrollMode dependency property.

public : static DependencyProperty VerticalScrollModeProperty { get; }
static DependencyProperty VerticalScrollModeProperty();
public static DependencyProperty VerticalScrollModeProperty { get; }
Public Static ReadOnly Property VerticalScrollModeProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the VerticalScrollMode dependency property.

VerticalSnapPointsAlignment VerticalSnapPointsAlignment VerticalSnapPointsAlignment VerticalSnapPointsAlignment

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

public : SnapPointsAlignment VerticalSnapPointsAlignment { get; set; }
SnapPointsAlignment VerticalSnapPointsAlignment(); void VerticalSnapPointsAlignment(SnapPointsAlignment verticalsnappointsalignment);
public SnapPointsAlignment VerticalSnapPointsAlignment { get; set; }
Public ReadWrite Property VerticalSnapPointsAlignment As SnapPointsAlignment
<ScrollViewer VerticalSnapPointsAlignment="snapPointsAlignmentMemberName" />
Value
SnapPointsAlignment SnapPointsAlignment

A value of the enumeration.

VerticalSnapPointsAlignmentProperty VerticalSnapPointsAlignmentProperty VerticalSnapPointsAlignmentProperty VerticalSnapPointsAlignmentProperty

Identifies the VerticalSnapPointsAlignment dependency property.

public : static DependencyProperty VerticalSnapPointsAlignmentProperty { get; }
static DependencyProperty VerticalSnapPointsAlignmentProperty();
public static DependencyProperty VerticalSnapPointsAlignmentProperty { get; }
Public Static ReadOnly Property VerticalSnapPointsAlignmentProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the VerticalSnapPointsAlignment dependency property.

VerticalSnapPointsType VerticalSnapPointsType VerticalSnapPointsType VerticalSnapPointsType

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

public : SnapPointsType VerticalSnapPointsType { get; set; }
SnapPointsType VerticalSnapPointsType(); void VerticalSnapPointsType(SnapPointsType verticalsnappointstype);
public SnapPointsType VerticalSnapPointsType { get; set; }
Public ReadWrite Property VerticalSnapPointsType As SnapPointsType
<ScrollViewer VerticalSnapPointsType="snapPointsTypeMemberName" />
Value
SnapPointsType SnapPointsType

A value of the enumeration. The default is None but might be set through a control template.

Examples

This XAML is from the default template for a Hub control. A Hub has a ScrollViewer part that surrounds an ItemsStackPanel for its content. Hub uses the Optional value for its snapping behavior in both dimensions (although VerticalScrollMode is disabled in starting visual states) and disables ZoomMode. Note how the SnapPointsAlignment properties are also set as attributes here.


<ControlTemplate TargetType="Hub">
...
<ScrollViewer x:Name="ScrollViewer"
    Grid.RowSpan="2"
    HorizontalScrollMode="Auto"
    HorizontalScrollBarVisibility="Auto"
    VerticalScrollMode="Disabled"
    VerticalScrollBarVisibility="Disabled"
    HorizontalSnapPointsAlignment="Near"
    HorizontalSnapPointsType="Optional"
    VerticalSnapPointsAlignment="Near"
    VerticalSnapPointsType="Optional"
    ZoomMode="Disabled">
  <ItemsStackPanel x:Name="Panel" 
       Orientation="{TemplateBinding Orientation}"
       CacheLength="20" />
</ScrollViewer>
...
</ControlTemplate>

Remarks

For panning actions, there are often natural stopping places. Snap points provide a way to indicate where these places are. Then, when a user swipes, the manipulation result favors that natural point using behavior as expressed by a SnapPointsType value.

Proximity points (Optional** and *OptionalSingle*): ** When a user is going to naturally stop the manipulation in the proximity of a snap point, proximity points help the user land at the natural stopping place. Because the user has to land in proximity to the snap point to cause it to stop there, the user will sometimes have to perform another swipe to reach a snap point.

Mandatory snap points (Mandatory** and *MandatorySingle*): ** In contrast to proximity, mandatory snap points ensure that the content is adjusted to always land on a snap point. Even if the user releases the manipulation halfway between two snap-points, it will always move to one of the snap points.

To see the effects of snap points on ScrollViewer behavior yourself, get the XAML scrolling, panning and zooming sample. Run the sample on a touch device (not the simulator). Try out the SnapPointsType values when you view the "Panning with snap-points" example page of the sample.

To learn more about the swipe gesture and panning, see the "Panning behaviors" section of Guidelines for panning.

The default value of None is the default of the enumeration. If it's set, this property is often set as an attribute in a XAML template part, or as a style Setter. Each control potentially sets this differently. Getting the value at run time will provide the value that came from applied styles and templates.

See Also

VerticalSnapPointsTypeProperty VerticalSnapPointsTypeProperty VerticalSnapPointsTypeProperty VerticalSnapPointsTypeProperty

Identifies the VerticalSnapPointsType dependency property.

public : static DependencyProperty VerticalSnapPointsTypeProperty { get; }
static DependencyProperty VerticalSnapPointsTypeProperty();
public static DependencyProperty VerticalSnapPointsTypeProperty { get; }
Public Static ReadOnly Property VerticalSnapPointsTypeProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the VerticalSnapPointsType dependency property.

ViewportHeight ViewportHeight ViewportHeight ViewportHeight

Gets the vertical size of the viewable content.

public : double ViewportHeight { get; }
double ViewportHeight();
public double ViewportHeight { get; }
Public ReadOnly Property ViewportHeight As double
Value
double double

The vertical size of the viewable content.

Remarks

The viewport includes all the visible content in the ScrollViewer.

See Also

ViewportHeightProperty ViewportHeightProperty ViewportHeightProperty ViewportHeightProperty

Identifies the ViewportHeight dependency property.

public : static DependencyProperty ViewportHeightProperty { get; }
static DependencyProperty ViewportHeightProperty();
public static DependencyProperty ViewportHeightProperty { get; }
Public Static ReadOnly Property ViewportHeightProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the ViewportHeight dependency property.

ViewportWidth ViewportWidth ViewportWidth ViewportWidth

Gets the horizontal size of the viewable content.

public : double ViewportWidth { get; }
double ViewportWidth();
public double ViewportWidth { get; }
Public ReadOnly Property ViewportWidth As double
Value
double double

The horizontal size of the viewable content.

Remarks

The viewport includes all the visible content in the ScrollViewer.

See Also

ViewportWidthProperty ViewportWidthProperty ViewportWidthProperty ViewportWidthProperty

Identifies the ViewportWidth dependency property.

public : static DependencyProperty ViewportWidthProperty { get; }
static DependencyProperty ViewportWidthProperty();
public static DependencyProperty ViewportWidthProperty { get; }
Public Static ReadOnly Property ViewportWidthProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the ViewportWidth dependency property.

Visibility Visibility Visibility Visibility

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)

VisibilityProperty VisibilityProperty VisibilityProperty VisibilityProperty

Identifies the Visibility dependency property.

(Inherited from UIElement)

Width Width Width Width

Gets or sets the width of a FrameworkElement.

(Inherited from FrameworkElement)

WidthProperty WidthProperty WidthProperty WidthProperty

Identifies the Width dependency property.

(Inherited from FrameworkElement)

XYFocusDown XYFocusDown XYFocusDown XYFocusDown

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) down.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

XYFocusDownNavigationStrategy XYFocusDownNavigationStrategy XYFocusDownNavigationStrategy XYFocusDownNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of a down navigation.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusDownNavigationStrategyProperty XYFocusDownNavigationStrategyProperty XYFocusDownNavigationStrategyProperty XYFocusDownNavigationStrategyProperty

Identifies the XYFocusDownNavigationStrategy dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusDownProperty XYFocusDownProperty XYFocusDownProperty XYFocusDownProperty

Identifies the XYFocusDown dependency property.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

XYFocusKeyboardNavigation XYFocusKeyboardNavigation XYFocusKeyboardNavigation XYFocusKeyboardNavigation

Gets or sets a value that enables or disables navigation using the keyboard directional arrows.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusKeyboardNavigationProperty XYFocusKeyboardNavigationProperty XYFocusKeyboardNavigationProperty XYFocusKeyboardNavigationProperty

Identifies the XYFocusKeyboardNavigation dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusLeft XYFocusLeft XYFocusLeft XYFocusLeft

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) left.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

XYFocusLeftNavigationStrategy XYFocusLeftNavigationStrategy XYFocusLeftNavigationStrategy XYFocusLeftNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of a left navigation.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusLeftNavigationStrategyProperty XYFocusLeftNavigationStrategyProperty XYFocusLeftNavigationStrategyProperty XYFocusLeftNavigationStrategyProperty

Identifies the XYFocusLeftNavigationStrategy dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusLeftProperty XYFocusLeftProperty XYFocusLeftProperty XYFocusLeftProperty

Identifies the XYFocusLeft dependency property.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

XYFocusRight XYFocusRight XYFocusRight XYFocusRight

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) right.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

XYFocusRightNavigationStrategy XYFocusRightNavigationStrategy XYFocusRightNavigationStrategy XYFocusRightNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of a right navigation.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusRightNavigationStrategyProperty XYFocusRightNavigationStrategyProperty XYFocusRightNavigationStrategyProperty XYFocusRightNavigationStrategyProperty

Identifies the XYFocusRightNavigationStrategy dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusRightProperty XYFocusRightProperty XYFocusRightProperty XYFocusRightProperty

Identifies the XYFocusRight dependency property.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

XYFocusUp XYFocusUp XYFocusUp XYFocusUp

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) up.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

XYFocusUpNavigationStrategy XYFocusUpNavigationStrategy XYFocusUpNavigationStrategy XYFocusUpNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of an up navigation.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusUpNavigationStrategyProperty XYFocusUpNavigationStrategyProperty XYFocusUpNavigationStrategyProperty XYFocusUpNavigationStrategyProperty

Identifies the XYFocusUpNavigationStrategy dependency property.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

XYFocusUpProperty XYFocusUpProperty XYFocusUpProperty XYFocusUpProperty

Identifies the XYFocusUp dependency property.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

ZoomFactor ZoomFactor ZoomFactor ZoomFactor

Gets a value that indicates the current zoom factor engaged for content scaling.

public : float ZoomFactor { get; }
float ZoomFactor();
public float ZoomFactor { get; }
Public ReadOnly Property ZoomFactor As float
Value
float float

The current zoom factor engaged for content scaling. The default is 1.0, where 1.0 indicates no additional scaling.

Remarks

To change the value of this property at run-time or for initialization, use ZoomToFactor.

ZoomFactorProperty ZoomFactorProperty ZoomFactorProperty ZoomFactorProperty

Identifies the ZoomFactor dependency property.

public : static DependencyProperty ZoomFactorProperty { get; }
static DependencyProperty ZoomFactorProperty();
public static DependencyProperty ZoomFactorProperty { get; }
Public Static ReadOnly Property ZoomFactorProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the ZoomFactor dependency property.

ZoomMode ZoomMode ZoomMode ZoomMode

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

public : ZoomMode ZoomMode { get; set; }
ZoomMode ZoomMode(); void ZoomMode(ZoomMode zoommode);
public ZoomMode ZoomMode { get; set; }
Public ReadWrite Property ZoomMode As ZoomMode
<ScrollViewer ZoomMode="zoomModeMemberName" />
-or-
<object ScrollViewer.ZoomMode="zoomModeMemberName"/>
Value
ZoomMode ZoomMode

A value of the enumeration.

Remarks

No default value is listed for this property. Controls that incorporate a ScrollViewer in compositing often set a value for ZoomMode in the default template and starting visual states, and it is this templated value that you will typically start with. Controls with a ScrollViewer as part of their composition typically use template binding such that setting the attached property at the level of the control will change the scroll behavior of the ScrollViewer part within the control. Otherwise, it may be necessary to replace the template in order to change the scroll behavior of a ScrollViewer part.

ZoomModeProperty ZoomModeProperty ZoomModeProperty ZoomModeProperty

Identifies the ZoomMode dependency property.

public : static DependencyProperty ZoomModeProperty { get; }
static DependencyProperty ZoomModeProperty();
public static DependencyProperty ZoomModeProperty { get; }
Public Static ReadOnly Property ZoomModeProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the ZoomMode dependency property.

ZoomSnapPoints ZoomSnapPoints ZoomSnapPoints ZoomSnapPoints

Gets the observable collection of zoom snap point factors that are held by the ScrollViewer.

public : IVector<float> ZoomSnapPoints { get; }
IVector<float> ZoomSnapPoints();
public IList<float> ZoomSnapPoints { get; }
Public ReadOnly Property ZoomSnapPoints As IList<float>
Value
IList<float> IList<float>

A collection of Single values that represent zoom factors as snap points.

ZoomSnapPointsProperty ZoomSnapPointsProperty ZoomSnapPointsProperty ZoomSnapPointsProperty

Identifies the ZoomSnapPoints dependency property.

public : static DependencyProperty ZoomSnapPointsProperty { get; }
static DependencyProperty ZoomSnapPointsProperty();
public static DependencyProperty ZoomSnapPointsProperty { get; }
Public Static ReadOnly Property ZoomSnapPointsProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the ZoomSnapPoints dependency property.

ZoomSnapPointsType ZoomSnapPointsType ZoomSnapPointsType ZoomSnapPointsType

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

public : SnapPointsType ZoomSnapPointsType { get; set; }
SnapPointsType ZoomSnapPointsType(); void ZoomSnapPointsType(SnapPointsType zoomsnappointstype);
public SnapPointsType ZoomSnapPointsType { get; set; }
Public ReadWrite Property ZoomSnapPointsType As SnapPointsType
<ScrollViewer ZoomSnapPointsType="snapPointsTypeMemberName"/>
Value
SnapPointsType SnapPointsType

A value of the enumeration.

See Also

ZoomSnapPointsTypeProperty ZoomSnapPointsTypeProperty ZoomSnapPointsTypeProperty ZoomSnapPointsTypeProperty

Identifies the ZoomSnapPointsType dependency property.

public : static DependencyProperty ZoomSnapPointsTypeProperty { get; }
static DependencyProperty ZoomSnapPointsTypeProperty();
public static DependencyProperty ZoomSnapPointsTypeProperty { get; }
Public Static ReadOnly Property ZoomSnapPointsTypeProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the ZoomSnapPointsType dependency property.

Methods

AddHandler(RoutedEvent,Object,Boolean) AddHandler(RoutedEvent,Object,Boolean) AddHandler(RoutedEvent,Object,Boolean) AddHandler(RoutedEvent,Object,Boolean)

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

Loads the relevant control template so that its parts can be referenced.

(Inherited from Control)

Arrange(Rect) Arrange(Rect) Arrange(Rect) Arrange(Rect)

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(Size) ArrangeOverride(Size) ArrangeOverride(Size) ArrangeOverride(Size)

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

Cancels ongoing direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement.

(Inherited from UIElement)

CapturePointer(Pointer) CapturePointer(Pointer) CapturePointer(Pointer) CapturePointer(Pointer)

Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events.

(Inherited from UIElement)

ChangeView(IReference, IReference, IReference) ChangeView(IReference, IReference, IReference) ChangeView(IReference, IReference, IReference) ChangeView(IReference, IReference, IReference)

Causes the ScrollViewer to load a new view into the viewport using the specified offsets and zoom factor.

public : Platform::Boolean ChangeView(IReference<double> horizontalOffset, IReference<double> verticalOffset, IReference<float> zoomFactor)
bool ChangeView(IReference<double> horizontalOffset, IReference<double> verticalOffset, IReference<Single> zoomFactor) const;
public bool ChangeView(Nullable<Double> horizontalOffset, Nullable<Double> verticalOffset, Nullable<Single> zoomFactor)
Public Function ChangeView(horizontalOffset As Nullable<Double>, verticalOffset As Nullable<Double>, zoomFactor As Nullable<Single>) As bool
Parameters
horizontalOffset
Nullable<Double> Nullable<Double>

A value between 0 and ScrollableWidth that specifies the distance the content should be scrolled horizontally.

verticalOffset
Nullable<Double> Nullable<Double>

A value between 0 and ScrollableHeight that specifies the distance the content should be scrolled vertically.

zoomFactor
Nullable<Single> Nullable<Single>

A value between MinZoomFactor and MaxZoomFactor that specifies the required target ZoomFactor.

Returns
bool bool

true if the view is changed; otherwise, false.

Examples

This code results in a ScrollViewer named myScrollViewer being scrolled to a horizontal offset of 2.

bool flag = myScrollViewer.ChangeView(2, null, null); 

Remarks

You can set parameter values to null to use this method to scroll only horizontally, only vertically, or to only change the zoom factor.

See Also

ChangeView(IReference, IReference, IReference, Boolean) ChangeView(IReference, IReference, IReference, Boolean) ChangeView(IReference, IReference, IReference, Boolean) ChangeView(IReference, IReference, IReference, Boolean)

Causes the ScrollViewer to load a new view into the viewport using the specified offsets and zoom factor, and optionally disables scrolling animation.

public : Platform::Boolean ChangeView(IReference<double> horizontalOffset, IReference<double> verticalOffset, IReference<float> zoomFactor, bool disableAnimation)
bool ChangeView(IReference<double> horizontalOffset, IReference<double> verticalOffset, IReference<Single> zoomFactor, bool disableAnimation) const;
public bool ChangeView(Nullable<Double> horizontalOffset, Nullable<Double> verticalOffset, Nullable<Single> zoomFactor, Boolean disableAnimation)
Public Function ChangeView(horizontalOffset As Nullable<Double>, verticalOffset As Nullable<Double>, zoomFactor As Nullable<Single>, disableAnimation As Boolean) As bool
Parameters
horizontalOffset
Nullable<Double> Nullable<Double>

A value between 0 and ScrollableWidth that specifies the distance the content should be scrolled horizontally.

verticalOffset
Nullable<Double> Nullable<Double>

A value between 0 and ScrollableHeight that specifies the distance the content should be scrolled vertically.

zoomFactor
Nullable<Single> Nullable<Single>

A value between MinZoomFactor and MaxZoomFactor that specifies the required target ZoomFactor.

disableAnimation
Boolean Boolean

true to disable zoom/pan animations while changing the view; otherwise, false. The default is false.

Returns
bool bool

true if the view is changed; otherwise, false.

Examples

This code results in a ScrollViewer named myScrollViewer being scrolled to a horizontal offset of 2 without animation.

bool flag = myScrollViewer.ChangeView(2, null, null, true); 

Remarks

You can set parameter values to null to use this method to scroll only horizontally, only vertically, or to only change the zoom factor.

See Also

ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Clears the local value of a dependency property.

(Inherited from DependencyObject)

DeferTree(DependencyObject) DeferTree(DependencyObject) DeferTree(DependencyObject) DeferTree(DependencyObject)

Removes the specified element from the XAML visual tree in a way that it can be undeferred later.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

FindName(String) FindName(String) FindName(String) FindName(String)

Retrieves an object that has the specified identifier name.

(Inherited from FrameworkElement)

FindSubElementsForTouchTargeting(Point,Rect) FindSubElementsForTouchTargeting(Point,Rect) FindSubElementsForTouchTargeting(Point,Rect) FindSubElementsForTouchTargeting(Point,Rect)

Enables a UIElement subclass to expose child elements that assist with resolving touch targeting.

(Inherited from UIElement)

Focus(FocusState) Focus(FocusState) Focus(FocusState) Focus(FocusState)

Attempts to set the focus on the control.

(Inherited from Control)

GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty)

Returns any base value established for a dependency property, which would apply in cases where an animation is not active.

(Inherited from DependencyObject)

GetBindingExpression(DependencyProperty) GetBindingExpression(DependencyProperty) GetBindingExpression(DependencyProperty) GetBindingExpression(DependencyProperty)

Returns the BindingExpression that represents the binding on the specified property.

(Inherited from FrameworkElement)

GetBringIntoViewOnFocusChange(DependencyObject) GetBringIntoViewOnFocusChange(DependencyObject) GetBringIntoViewOnFocusChange(DependencyObject) GetBringIntoViewOnFocusChange(DependencyObject)

Gets the value of the BringIntoViewOnFocusChange dependency property / ScrollViewer.BringIntoViewOnFocusChange XAML attached property from a specified element.

public : static Platform::Boolean GetBringIntoViewOnFocusChange(DependencyObject element)
bool GetBringIntoViewOnFocusChange(DependencyObject element) const;
public static bool GetBringIntoViewOnFocusChange(DependencyObject element)
Public Static Function GetBringIntoViewOnFocusChange(element As DependencyObject) As bool
Parameters
element
DependencyObject DependencyObject

The element from which the property value is read.

Returns
bool bool

The value of the property, as obtained from the property store.

Remarks

For more info, see Remarks for the BringIntoViewOnFocusChange property.

See Also

GetChildrenInTabFocusOrder GetChildrenInTabFocusOrder GetChildrenInTabFocusOrder GetChildrenInTabFocusOrder

Enables a UIElement subclass to expose child elements that take part in Tab focus.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

GetHorizontalScrollBarVisibility(DependencyObject) GetHorizontalScrollBarVisibility(DependencyObject) GetHorizontalScrollBarVisibility(DependencyObject) GetHorizontalScrollBarVisibility(DependencyObject)

Gets the value of the HorizontalScrollBarVisibility dependency property / ScrollViewer.HorizontalScrollBarVisibility XAML attached property from a specified element.

public : static ScrollBarVisibility GetHorizontalScrollBarVisibility(DependencyObject element)
ScrollBarVisibility GetHorizontalScrollBarVisibility(DependencyObject element) const;
public static ScrollBarVisibility GetHorizontalScrollBarVisibility(DependencyObject element)
Public Static Function GetHorizontalScrollBarVisibility(element As DependencyObject) As ScrollBarVisibility
Parameters
element
DependencyObject DependencyObject

The element from which the property value is read.

Returns

The value of the property, as obtained from the property store.

Remarks

For more info, see Remarks for the HorizontalScrollBarVisibility property.

See Also

GetHorizontalScrollMode(DependencyObject) GetHorizontalScrollMode(DependencyObject) GetHorizontalScrollMode(DependencyObject) GetHorizontalScrollMode(DependencyObject)

Gets the value of the HorizontalScrollMode dependency property / ScrollViewer.HorizontalScrollMode XAML attached property from a specified element.

public : static ScrollMode GetHorizontalScrollMode(DependencyObject element)
ScrollMode GetHorizontalScrollMode(DependencyObject element) const;
public static ScrollMode GetHorizontalScrollMode(DependencyObject element)
Public Static Function GetHorizontalScrollMode(element As DependencyObject) As ScrollMode
Parameters
element
DependencyObject DependencyObject

The element from which the property value is read.

Returns

The value of the property, as obtained from the property store.

Remarks

For more info, see Remarks for the HorizontalScrollMode property.

See Also

GetIsDeferredScrollingEnabled(DependencyObject) GetIsDeferredScrollingEnabled(DependencyObject) GetIsDeferredScrollingEnabled(DependencyObject) GetIsDeferredScrollingEnabled(DependencyObject)

Gets the value of the IsDeferredScrollingEnabled dependency property / ScrollViewer.IsDeferredScrollingInertiaEnabled XAML attached property from a specified element.

public : static Platform::Boolean GetIsDeferredScrollingEnabled(DependencyObject element)
bool GetIsDeferredScrollingEnabled(DependencyObject element) const;
public static bool GetIsDeferredScrollingEnabled(DependencyObject element)
Public Static Function GetIsDeferredScrollingEnabled(element As DependencyObject) As bool
Parameters
element
DependencyObject DependencyObject

The element from which the property value is read.

Returns
bool bool

The value of the property, as obtained from the property store.

Remarks

For more info, see Remarks for the IsDeferredScrollingEnabled property.

See Also

GetIsHorizontalRailEnabled(DependencyObject) GetIsHorizontalRailEnabled(DependencyObject) GetIsHorizontalRailEnabled(DependencyObject) GetIsHorizontalRailEnabled(DependencyObject)

Gets the value of the IsHorizontalRailEnabled dependency property / ScrollViewer.IsHorizontalRailEnabled XAML attached property from a specified element.

public : static Platform::Boolean GetIsHorizontalRailEnabled(DependencyObject element)
bool GetIsHorizontalRailEnabled(DependencyObject element) const;
public static bool GetIsHorizontalRailEnabled(DependencyObject element)
Public Static Function GetIsHorizontalRailEnabled(element As DependencyObject) As bool
Parameters
element
DependencyObject DependencyObject

The element from which the property value is read.

Returns
bool bool

The value of the property, as obtained from the property store.

Remarks

For more info, see the IsHorizontalRailEnabled property.

See Also

GetIsHorizontalScrollChainingEnabled(DependencyObject) GetIsHorizontalScrollChainingEnabled(DependencyObject) GetIsHorizontalScrollChainingEnabled(DependencyObject) GetIsHorizontalScrollChainingEnabled(DependencyObject)

Gets the value of the IsHorizontalScrollChainingEnabled dependency property / ScrollViewer.IsHorizontalScrollChainingEnabled XAML attached property from a specified element.

public : static Platform::Boolean GetIsHorizontalScrollChainingEnabled(DependencyObject element)
bool GetIsHorizontalScrollChainingEnabled(DependencyObject element) const;
public static bool GetIsHorizontalScrollChainingEnabled(DependencyObject element)
Public Static Function GetIsHorizontalScrollChainingEnabled(element As DependencyObject) As bool
Parameters
element
DependencyObject DependencyObject

The element from which the property value is read.

Returns
bool bool

The value of the property, as obtained from the property store.

Remarks

For more info, see the IsHorizontalScrollChainingEnabled property.

See Also

GetIsScrollInertiaEnabled(DependencyObject) GetIsScrollInertiaEnabled(DependencyObject) GetIsScrollInertiaEnabled(DependencyObject) GetIsScrollInertiaEnabled(DependencyObject)

Gets the value of the IsScrollInertiaEnabled dependency property / ScrollViewer.IsScrollInertiaEnabled XAML attached property from a specified element.

public : static Platform::Boolean GetIsScrollInertiaEnabled(DependencyObject element)
bool GetIsScrollInertiaEnabled(DependencyObject element) const;
public static bool GetIsScrollInertiaEnabled(DependencyObject element)
Public Static Function GetIsScrollInertiaEnabled(element As DependencyObject) As bool
Parameters
element
DependencyObject DependencyObject

The element from which the property value is read.

Returns
bool bool

The value of the property, as obtained from the property store.

Remarks

For more info, see the IsScrollInertiaEnabled property.

See Also

GetIsTemplateFocusTarget(FrameworkElement) GetIsTemplateFocusTarget(FrameworkElement) GetIsTemplateFocusTarget(FrameworkElement) GetIsTemplateFocusTarget(FrameworkElement)

Gets the value of the Control.IsTemplateFocusTarget XAML attached property for the target element.

(Inherited from Control)

GetIsTemplateKeyTipTarget(DependencyObject) GetIsTemplateKeyTipTarget(DependencyObject) GetIsTemplateKeyTipTarget(DependencyObject) GetIsTemplateKeyTipTarget(DependencyObject)

Gets the value of the Control.IsTemplateKeyTipTarget XAML attached property for the target element.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

GetIsVerticalRailEnabled(DependencyObject) GetIsVerticalRailEnabled(DependencyObject) GetIsVerticalRailEnabled(DependencyObject) GetIsVerticalRailEnabled(DependencyObject)

Gets the value of the IsVerticalRailEnabled dependency property / ScrollViewer.IsVerticalRailEnabled XAML attached property from a specified element.

public : static Platform::Boolean GetIsVerticalRailEnabled(DependencyObject element)
bool GetIsVerticalRailEnabled(DependencyObject element) const;
public static bool GetIsVerticalRailEnabled(DependencyObject element)
Public Static Function GetIsVerticalRailEnabled(element As DependencyObject) As bool
Parameters
element
DependencyObject DependencyObject

The element from which the property value is read.

Returns
bool bool

The value of the property, as obtained from the property store.

Remarks

For more info, see the IsVerticalRailEnabled property.

See Also

GetIsVerticalScrollChainingEnabled(DependencyObject) GetIsVerticalScrollChainingEnabled(DependencyObject) GetIsVerticalScrollChainingEnabled(DependencyObject) GetIsVerticalScrollChainingEnabled(DependencyObject)

Gets the value of the IsVerticalScrollChainingEnabled dependency property / ScrollViewer.IsVerticalScrollChainingEnabled XAML attached property from a specified element.

public : static Platform::Boolean GetIsVerticalScrollChainingEnabled(DependencyObject element)
bool GetIsVerticalScrollChainingEnabled(DependencyObject element) const;
public static bool GetIsVerticalScrollChainingEnabled(DependencyObject element)
Public Static Function GetIsVerticalScrollChainingEnabled(element As DependencyObject) As bool
Parameters
element
DependencyObject DependencyObject

The element from which the property value is read.

Returns
bool bool

The value of the property, as obtained from the property store.

Remarks

For more info, see the IsVerticalScrollChainingEnabled property.

See Also

GetIsZoomChainingEnabled(DependencyObject) GetIsZoomChainingEnabled(DependencyObject) GetIsZoomChainingEnabled(DependencyObject) GetIsZoomChainingEnabled(DependencyObject)

Gets the value of the IsZoomChainingEnabled dependency property / ScrollViewer.IsZoomChainingEnabled XAML attached property from a specified element.

public : static Platform::Boolean GetIsZoomChainingEnabled(DependencyObject element)
bool GetIsZoomChainingEnabled(DependencyObject element) const;
public static bool GetIsZoomChainingEnabled(DependencyObject element)
Public Static Function GetIsZoomChainingEnabled(element As DependencyObject) As bool
Parameters
element
DependencyObject DependencyObject

The element from which the property value is read.

Returns
bool bool

The value of the property, as obtained from the property store.

Remarks

For more info, see the IsZoomChainingEnabled property.

See Also

GetIsZoomInertiaEnabled(DependencyObject) GetIsZoomInertiaEnabled(DependencyObject) GetIsZoomInertiaEnabled(DependencyObject) GetIsZoomInertiaEnabled(DependencyObject)

Gets the value of the IsZoomInertiaEnabled dependency property / ScrollViewer.IsZoomInertiaEnabled XAML attached property from a specified element.

public : static Platform::Boolean GetIsZoomInertiaEnabled(DependencyObject element)
bool GetIsZoomInertiaEnabled(DependencyObject element) const;
public static bool GetIsZoomInertiaEnabled(DependencyObject element)
Public Static Function GetIsZoomInertiaEnabled(element As DependencyObject) As bool
Parameters
element
DependencyObject DependencyObject

The element from which the property value is read.

Returns
bool bool

The value of the property, as obtained from the property store.

Remarks

For more info, see the IsZoomInertiaEnabled property.

See Also

GetTemplateChild(String) GetTemplateChild(String) GetTemplateChild(String) GetTemplateChild(String)

Retrieves the named element in the instantiated ControlTemplate visual tree.

(Inherited from Control)

GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

Returns the current effective value of a dependency property from a DependencyObject.

(Inherited from DependencyObject)

GetVerticalScrollBarVisibility(DependencyObject) GetVerticalScrollBarVisibility(DependencyObject) GetVerticalScrollBarVisibility(DependencyObject) GetVerticalScrollBarVisibility(DependencyObject)

Gets the value of the VerticalScrollBarVisibility dependency property / ScrollViewer.VerticalScrollBarVisibility XAML attached property from a specified element.

public : static ScrollBarVisibility GetVerticalScrollBarVisibility(DependencyObject element)
ScrollBarVisibility GetVerticalScrollBarVisibility(DependencyObject element) const;
public static ScrollBarVisibility GetVerticalScrollBarVisibility(DependencyObject element)
Public Static Function GetVerticalScrollBarVisibility(element As DependencyObject) As ScrollBarVisibility
Parameters
element
DependencyObject DependencyObject

The element from which the property value is read.

Returns

The value of the property, as obtained from the property store.

Remarks

For more info, see the VerticalScrollBarVisibility property.

See Also

GetVerticalScrollMode(DependencyObject) GetVerticalScrollMode(DependencyObject) GetVerticalScrollMode(DependencyObject) GetVerticalScrollMode(DependencyObject)

Gets the value of the VerticalScrollMode dependency property / ScrollViewer.VerticalScrollMode XAML attached property from a specified element.

public : static ScrollMode GetVerticalScrollMode(DependencyObject element)
ScrollMode GetVerticalScrollMode(DependencyObject element) const;
public static ScrollMode GetVerticalScrollMode(DependencyObject element)
Public Static Function GetVerticalScrollMode(element As DependencyObject) As ScrollMode
Parameters
element
DependencyObject DependencyObject

The element from which the property value is read.

Returns

The value of the property, as obtained from the property store.

Remarks

For more info, see the VerticalScrollMode property.

See Also

GetZoomMode(DependencyObject) GetZoomMode(DependencyObject) GetZoomMode(DependencyObject) GetZoomMode(DependencyObject)

Gets the value of the ZoomMode dependency property / ScrollViewer.ZoomMode XAML attached property from a specified element.

public : static ZoomMode GetZoomMode(DependencyObject element)
ZoomMode GetZoomMode(DependencyObject element) const;
public static ZoomMode GetZoomMode(DependencyObject element)
Public Static Function GetZoomMode(element As DependencyObject) As ZoomMode
Parameters
element
DependencyObject DependencyObject

The element from which the property value is read.

Returns

The value of the property, as obtained from the property store.

Remarks

For more info, see the ZoomMode property.

See Also

GoToElementStateCore(String,Boolean) GoToElementStateCore(String,Boolean) GoToElementStateCore(String,Boolean) GoToElementStateCore(String,Boolean)

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 InvalidateArrange InvalidateArrange 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 InvalidateMeasure InvalidateMeasure InvalidateMeasure

Invalidates the measurement state (layout) for a UIElement.

(Inherited from UIElement)

InvalidateScrollInfo() InvalidateScrollInfo() InvalidateScrollInfo() InvalidateScrollInfo()

Called when the value of properties that describe the size and location of the scroll area change.

public : void InvalidateScrollInfo()
void InvalidateScrollInfo() const;
public void InvalidateScrollInfo()
Public Function InvalidateScrollInfo() As void

Measure(Size) Measure(Size) Measure(Size) Measure(Size)

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(Size) MeasureOverride(Size) MeasureOverride(Size) MeasureOverride(Size)

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 OnApplyTemplate OnApplyTemplate 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)

OnBringIntoViewRequested(BringIntoViewRequestedEventArgs) OnBringIntoViewRequested(BringIntoViewRequestedEventArgs) OnBringIntoViewRequested(BringIntoViewRequestedEventArgs) OnBringIntoViewRequested(BringIntoViewRequestedEventArgs)

Prerelease. Called before the BringIntoViewRequested event occurs.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.17095.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v6)

OnCharacterReceived(CharacterReceivedRoutedEventArgs) OnCharacterReceived(CharacterReceivedRoutedEventArgs) OnCharacterReceived(CharacterReceivedRoutedEventArgs) OnCharacterReceived(CharacterReceivedRoutedEventArgs)

Called before the CharacterReceived event occurs.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

OnContentChanged(Object,Object) OnContentChanged(Object,Object) OnContentChanged(Object,Object) OnContentChanged(Object,Object)

Invoked when the value of the Content property changes.

(Inherited from ContentControl)

OnContentTemplateChanged(DataTemplate,DataTemplate) OnContentTemplateChanged(DataTemplate,DataTemplate) OnContentTemplateChanged(DataTemplate,DataTemplate) OnContentTemplateChanged(DataTemplate,DataTemplate)

Invoked when the value of the ContentTemplate property changes.

(Inherited from ContentControl)

OnContentTemplateSelectorChanged(DataTemplateSelector,DataTemplateSelector) OnContentTemplateSelectorChanged(DataTemplateSelector,DataTemplateSelector) OnContentTemplateSelectorChanged(DataTemplateSelector,DataTemplateSelector) OnContentTemplateSelectorChanged(DataTemplateSelector,DataTemplateSelector)

Invoked when the value of the ContentTemplateSelector property changes.

(Inherited from ContentControl)

OnCreateAutomationPeer OnCreateAutomationPeer OnCreateAutomationPeer OnCreateAutomationPeer

When implemented in a derived class, returns class-specific AutomationPeer implementations for the Microsoft UI Automation infrastructure.

(Inherited from UIElement)

OnDisconnectVisualChildren OnDisconnectVisualChildren OnDisconnectVisualChildren 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(DoubleTappedRoutedEventArgs) OnDoubleTapped(DoubleTappedRoutedEventArgs) OnDoubleTapped(DoubleTappedRoutedEventArgs) OnDoubleTapped(DoubleTappedRoutedEventArgs)

Called before the DoubleTapped event occurs.

(Inherited from Control)

OnDragEnter(DragEventArgs) OnDragEnter(DragEventArgs) OnDragEnter(DragEventArgs) OnDragEnter(DragEventArgs)

Called before the DragEnter event occurs.

(Inherited from Control)

OnDragLeave(DragEventArgs) OnDragLeave(DragEventArgs) OnDragLeave(DragEventArgs) OnDragLeave(DragEventArgs)

Called before the DragLeave event occurs.

(Inherited from Control)

OnDragOver(DragEventArgs) OnDragOver(DragEventArgs) OnDragOver(DragEventArgs) OnDragOver(DragEventArgs)

Called before the DragOver event occurs.

(Inherited from Control)

OnDrop(DragEventArgs) OnDrop(DragEventArgs) OnDrop(DragEventArgs) OnDrop(DragEventArgs)

Called before the Drop event occurs.

(Inherited from Control)

OnGotFocus(RoutedEventArgs) OnGotFocus(RoutedEventArgs) OnGotFocus(RoutedEventArgs) OnGotFocus(RoutedEventArgs)

Called before the GotFocus event occurs.

(Inherited from Control)

OnHolding(HoldingRoutedEventArgs) OnHolding(HoldingRoutedEventArgs) OnHolding(HoldingRoutedEventArgs) OnHolding(HoldingRoutedEventArgs)

Called before the Holding event occurs.

(Inherited from Control)

OnKeyDown(KeyRoutedEventArgs) OnKeyDown(KeyRoutedEventArgs) OnKeyDown(KeyRoutedEventArgs) OnKeyDown(KeyRoutedEventArgs)

Called before the KeyDown event occurs.

(Inherited from Control)

OnKeyUp(KeyRoutedEventArgs) OnKeyUp(KeyRoutedEventArgs) OnKeyUp(KeyRoutedEventArgs) OnKeyUp(KeyRoutedEventArgs)

Called before the KeyUp event occurs.

(Inherited from Control)

OnKeyboardAcceleratorInvoked(KeyboardAcceleratorInvokedEventArgs) OnKeyboardAcceleratorInvoked(KeyboardAcceleratorInvokedEventArgs) OnKeyboardAcceleratorInvoked(KeyboardAcceleratorInvokedEventArgs) OnKeyboardAcceleratorInvoked(KeyboardAcceleratorInvokedEventArgs)

Prerelease. Called when a keyboard shortcut (or accelerator) is processed in your app. Override this method to handle how your app responds when a keyboard accelerator is invoked.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.17095.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v6)

OnLostFocus(RoutedEventArgs) OnLostFocus(RoutedEventArgs) OnLostFocus(RoutedEventArgs) OnLostFocus(RoutedEventArgs)

Called before the LostFocus event occurs.

(Inherited from Control)

OnManipulationCompleted(ManipulationCompletedRoutedEventArgs) OnManipulationCompleted(ManipulationCompletedRoutedEventArgs) OnManipulationCompleted(ManipulationCompletedRoutedEventArgs) OnManipulationCompleted(ManipulationCompletedRoutedEventArgs)

Called before the ManipulationCompleted event occurs.

(Inherited from Control)

OnManipulationDelta(ManipulationDeltaRoutedEventArgs) OnManipulationDelta(ManipulationDeltaRoutedEventArgs) OnManipulationDelta(ManipulationDeltaRoutedEventArgs) OnManipulationDelta(ManipulationDeltaRoutedEventArgs)

Called before the ManipulationDelta event occurs.

(Inherited from Control)

OnManipulationInertiaStarting(ManipulationInertiaStartingRoutedEventArgs) OnManipulationInertiaStarting(ManipulationInertiaStartingRoutedEventArgs) OnManipulationInertiaStarting(ManipulationInertiaStartingRoutedEventArgs) OnManipulationInertiaStarting(ManipulationInertiaStartingRoutedEventArgs)

Called before the ManipulationInertiaStarting event occurs.

(Inherited from Control)

OnManipulationStarted(ManipulationStartedRoutedEventArgs) OnManipulationStarted(ManipulationStartedRoutedEventArgs) OnManipulationStarted(ManipulationStartedRoutedEventArgs) OnManipulationStarted(ManipulationStartedRoutedEventArgs)

Called before the ManipulationStarted event occurs.

(Inherited from Control)

OnManipulationStarting(ManipulationStartingRoutedEventArgs) OnManipulationStarting(ManipulationStartingRoutedEventArgs) OnManipulationStarting(ManipulationStartingRoutedEventArgs) OnManipulationStarting(ManipulationStartingRoutedEventArgs)

Called before the ManipulationStarting event occurs.

(Inherited from Control)

OnPointerCanceled(PointerRoutedEventArgs) OnPointerCanceled(PointerRoutedEventArgs) OnPointerCanceled(PointerRoutedEventArgs) OnPointerCanceled(PointerRoutedEventArgs)

Called before the PointerCanceled event occurs.

(Inherited from Control)

OnPointerCaptureLost(PointerRoutedEventArgs) OnPointerCaptureLost(PointerRoutedEventArgs) OnPointerCaptureLost(PointerRoutedEventArgs) OnPointerCaptureLost(PointerRoutedEventArgs)

Called before the PointerCaptureLost event occurs.

(Inherited from Control)

OnPointerEntered(PointerRoutedEventArgs) OnPointerEntered(PointerRoutedEventArgs) OnPointerEntered(PointerRoutedEventArgs) OnPointerEntered(PointerRoutedEventArgs)

Called before the PointerEntered event occurs.

(Inherited from Control)

OnPointerExited(PointerRoutedEventArgs) OnPointerExited(PointerRoutedEventArgs) OnPointerExited(PointerRoutedEventArgs) OnPointerExited(PointerRoutedEventArgs)

Called before the PointerExited event occurs.

(Inherited from Control)

OnPointerMoved(PointerRoutedEventArgs) OnPointerMoved(PointerRoutedEventArgs) OnPointerMoved(PointerRoutedEventArgs) OnPointerMoved(PointerRoutedEventArgs)

Called before the PointerMoved event occurs.

(Inherited from Control)

OnPointerPressed(PointerRoutedEventArgs) OnPointerPressed(PointerRoutedEventArgs) OnPointerPressed(PointerRoutedEventArgs) OnPointerPressed(PointerRoutedEventArgs)

Called before the PointerPressed event occurs.

(Inherited from Control)

OnPointerReleased(PointerRoutedEventArgs) OnPointerReleased(PointerRoutedEventArgs) OnPointerReleased(PointerRoutedEventArgs) OnPointerReleased(PointerRoutedEventArgs)

Called before the PointerReleased event occurs.

(Inherited from Control)

OnPointerWheelChanged(PointerRoutedEventArgs) OnPointerWheelChanged(PointerRoutedEventArgs) OnPointerWheelChanged(PointerRoutedEventArgs) OnPointerWheelChanged(PointerRoutedEventArgs)

Called before the PointerWheelChanged event occurs.

(Inherited from Control)

OnPreviewKeyDown(KeyRoutedEventArgs) OnPreviewKeyDown(KeyRoutedEventArgs) OnPreviewKeyDown(KeyRoutedEventArgs) OnPreviewKeyDown(KeyRoutedEventArgs)

Called before the PreviewKeyDown event occurs.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

OnPreviewKeyUp(KeyRoutedEventArgs) OnPreviewKeyUp(KeyRoutedEventArgs) OnPreviewKeyUp(KeyRoutedEventArgs) OnPreviewKeyUp(KeyRoutedEventArgs)

Called before the PreviewKeyUp event occurs.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs)

Called just before a keyboard shortcut (or accelerator) is processed in your app. Invoked whenever application code or internal processes call ProcessKeyboardAccelerators. Override this method to influence the default accelerator handling.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

OnRightTapped(RightTappedRoutedEventArgs) OnRightTapped(RightTappedRoutedEventArgs) OnRightTapped(RightTappedRoutedEventArgs) OnRightTapped(RightTappedRoutedEventArgs)

Called before the RightTapped event occurs.

(Inherited from Control)

OnTapped(TappedRoutedEventArgs) OnTapped(TappedRoutedEventArgs) OnTapped(TappedRoutedEventArgs) OnTapped(TappedRoutedEventArgs)

Called before the Tapped event occurs.

(Inherited from Control)

ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if a local value is set.

(Inherited from DependencyObject)

RegisterAsScrollPort(UIElement) RegisterAsScrollPort(UIElement) RegisterAsScrollPort(UIElement) RegisterAsScrollPort(UIElement)

Prerelease. Registers an element as representing a scrollable viewport.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.17095.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v6)

RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback)

Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance.

(Inherited from DependencyObject)

ReleasePointerCapture(Pointer) ReleasePointerCapture(Pointer) ReleasePointerCapture(Pointer) ReleasePointerCapture(Pointer)

Releases pointer captures for capture of one specific pointer by this UIElement.

(Inherited from UIElement)

ReleasePointerCaptures ReleasePointerCaptures ReleasePointerCaptures ReleasePointerCaptures

Releases all pointer captures held by this element.

(Inherited from UIElement)

RemoveFocusEngagement RemoveFocusEngagement RemoveFocusEngagement RemoveFocusEngagement

Releases focus from the control boundaries for a control that has focus engagement (for game pad/remote interaction).

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

RemoveHandler(RoutedEvent,Object) RemoveHandler(RoutedEvent,Object) RemoveHandler(RoutedEvent,Object) RemoveHandler(RoutedEvent,Object)

Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler.

(Inherited from UIElement)

ScrollToHorizontalOffset(Double) ScrollToHorizontalOffset(Double) ScrollToHorizontalOffset(Double) ScrollToHorizontalOffset(Double)

Note

ScrollToHorizontalOffset may be altered or unavailable for releases after Windows 8.1. Instead, use ChangeView.

Scrolls the content that is within the ScrollViewer to the specified horizontal offset position.

public : void ScrollToHorizontalOffset(double offset)
void ScrollToHorizontalOffset(double offset) const;
public void ScrollToHorizontalOffset(Double offset)
Public Function ScrollToHorizontalOffset(offset As Double) As void
Parameters
offset
Double Double

The position that the content scrolls to.

ScrollToVerticalOffset(Double) ScrollToVerticalOffset(Double) ScrollToVerticalOffset(Double) ScrollToVerticalOffset(Double)

Note

ScrollToVerticalOffset may be altered or unavailable for releases after Windows 8.1. Instead, use ChangeView.

Scrolls the content that is within the ScrollViewer to the specified vertical offset position.

public : void ScrollToVerticalOffset(double offset)
void ScrollToVerticalOffset(double offset) const;
public void ScrollToVerticalOffset(Double offset)
Public Function ScrollToVerticalOffset(offset As Double) As void
Parameters
offset
Double Double

The position that the content scrolls to.

SetBinding(DependencyProperty,BindingBase) SetBinding(DependencyProperty,BindingBase) SetBinding(DependencyProperty,BindingBase) SetBinding(DependencyProperty,BindingBase)

Attaches a binding to a FrameworkElement, using the provided binding object

.

(Inherited from FrameworkElement)

SetBringIntoViewOnFocusChange(DependencyObject, Boolean) SetBringIntoViewOnFocusChange(DependencyObject, Boolean) SetBringIntoViewOnFocusChange(DependencyObject, Boolean) SetBringIntoViewOnFocusChange(DependencyObject, Boolean)

Sets the value of the BringIntoViewOnFocusChange dependency property / ScrollViewer.BringIntoViewOnFocusChange XAML attached property on a specified element.

public : static void SetBringIntoViewOnFocusChange(DependencyObject element, bool bringIntoViewOnFocusChange)
void SetBringIntoViewOnFocusChange(DependencyObject element, bool bringIntoViewOnFocusChange) const;
public static void SetBringIntoViewOnFocusChange(DependencyObject element, Boolean bringIntoViewOnFocusChange)
Public Static Function SetBringIntoViewOnFocusChange(element As DependencyObject, bringIntoViewOnFocusChange As Boolean) As void
Parameters
element
DependencyObject DependencyObject

The element on which to set the property value.

bringIntoViewOnFocusChange
Boolean Boolean

The value to set.

Remarks

For more info, see Remarks for the BringIntoViewOnFocusChange property.

See Also

SetHorizontalScrollBarVisibility(DependencyObject, ScrollBarVisibility) SetHorizontalScrollBarVisibility(DependencyObject, ScrollBarVisibility) SetHorizontalScrollBarVisibility(DependencyObject, ScrollBarVisibility) SetHorizontalScrollBarVisibility(DependencyObject, ScrollBarVisibility)

Sets the value of the HorizontalScrollBarVisibility dependency property / ScrollViewer.HorizontalScrollBarVisibility XAML attached property on a specified element.

public : static void SetHorizontalScrollBarVisibility(DependencyObject element, ScrollBarVisibility horizontalScrollBarVisibility)
void SetHorizontalScrollBarVisibility(DependencyObject element, ScrollBarVisibility horizontalScrollBarVisibility) const;
public static void SetHorizontalScrollBarVisibility(DependencyObject element, ScrollBarVisibility horizontalScrollBarVisibility)
Public Static Function SetHorizontalScrollBarVisibility(element As DependencyObject, horizontalScrollBarVisibility As ScrollBarVisibility) As void
Parameters
element
DependencyObject DependencyObject

The element on which to set the property value.

horizontalScrollBarVisibility
ScrollBarVisibility ScrollBarVisibility

The value to set.

Remarks

For more info, see Remarks for the HorizontalScrollBarVisibility property.

See Also

SetHorizontalScrollMode(DependencyObject, ScrollMode) SetHorizontalScrollMode(DependencyObject, ScrollMode) SetHorizontalScrollMode(DependencyObject, ScrollMode) SetHorizontalScrollMode(DependencyObject, ScrollMode)

Sets the value of the HorizontalScrollMode dependency property / ScrollViewer.HorizontalScrollMode XAML attached property on a specified element.

public : static void SetHorizontalScrollMode(DependencyObject element, ScrollMode horizontalScrollMode)
void SetHorizontalScrollMode(DependencyObject element, ScrollMode horizontalScrollMode) const;
public static void SetHorizontalScrollMode(DependencyObject element, ScrollMode horizontalScrollMode)
Public Static Function SetHorizontalScrollMode(element As DependencyObject, horizontalScrollMode As ScrollMode) As void
Parameters
element
DependencyObject DependencyObject

The element on which to set the property value.

horizontalScrollMode
ScrollMode ScrollMode

The value to set.

Remarks

For more info, see Remarks for the HorizontalScrollMode property.

See Also

SetIsDeferredScrollingEnabled(DependencyObject, Boolean) SetIsDeferredScrollingEnabled(DependencyObject, Boolean) SetIsDeferredScrollingEnabled(DependencyObject, Boolean) SetIsDeferredScrollingEnabled(DependencyObject, Boolean)

Sets the value of the IsDeferredScrollingEnabled dependency property / ScrollViewer.IsDeferredScrollingEnabled XAML attached property on a specified element.

public : static void SetIsDeferredScrollingEnabled(DependencyObject element, bool isDeferredScrollingEnabled)
void SetIsDeferredScrollingEnabled(DependencyObject element, bool isDeferredScrollingEnabled) const;
public static void SetIsDeferredScrollingEnabled(DependencyObject element, Boolean isDeferredScrollingEnabled)
Public Static Function SetIsDeferredScrollingEnabled(element As DependencyObject, isDeferredScrollingEnabled As Boolean) As void
Parameters
element
DependencyObject DependencyObject

The element on which to set the property value.

isDeferredScrollingEnabled
Boolean Boolean

The value to set.

Remarks

For more info, see Remarks for the IsDeferredScrollingEnabled property.

See Also

SetIsHorizontalRailEnabled(DependencyObject, Boolean) SetIsHorizontalRailEnabled(DependencyObject, Boolean) SetIsHorizontalRailEnabled(DependencyObject, Boolean) SetIsHorizontalRailEnabled(DependencyObject, Boolean)

Sets the value of the IsHorizontalRailEnabled dependency property / ScrollViewer.IsHorizontalRailEnabled XAML attached property on a specified element.

public : static void SetIsHorizontalRailEnabled(DependencyObject element, bool isHorizontalRailEnabled)
void SetIsHorizontalRailEnabled(DependencyObject element, bool isHorizontalRailEnabled) const;
public static void SetIsHorizontalRailEnabled(DependencyObject element, Boolean isHorizontalRailEnabled)
Public Static Function SetIsHorizontalRailEnabled(element As DependencyObject, isHorizontalRailEnabled As Boolean) As void
Parameters
element
DependencyObject DependencyObject

The element on which to set the property value.

isHorizontalRailEnabled
Boolean Boolean

The value to set.

Remarks

For more info, see the IsHorizontalRailEnabled property.

See Also

SetIsHorizontalScrollChainingEnabled(DependencyObject, Boolean) SetIsHorizontalScrollChainingEnabled(DependencyObject, Boolean) SetIsHorizontalScrollChainingEnabled(DependencyObject, Boolean) SetIsHorizontalScrollChainingEnabled(DependencyObject, Boolean)

Sets the value of the IsHorizontalScrollChainingEnabled dependency property / ScrollViewer.IsHorizontalScrollChainingEnabled XAML attached property on a specified element.

public : static void SetIsHorizontalScrollChainingEnabled(DependencyObject element, bool isHorizontalScrollChainingEnabled)
void SetIsHorizontalScrollChainingEnabled(DependencyObject element, bool isHorizontalScrollChainingEnabled) const;
public static void SetIsHorizontalScrollChainingEnabled(DependencyObject element, Boolean isHorizontalScrollChainingEnabled)
Public Static Function SetIsHorizontalScrollChainingEnabled(element As DependencyObject, isHorizontalScrollChainingEnabled As Boolean) As void
Parameters
element
DependencyObject DependencyObject

The element on which to set the property value.

isHorizontalScrollChainingEnabled
Boolean Boolean

The value to set.

Remarks

For more info, see the IsHorizontalScrollChainingEnabled property.

See Also

SetIsScrollInertiaEnabled(DependencyObject, Boolean) SetIsScrollInertiaEnabled(DependencyObject, Boolean) SetIsScrollInertiaEnabled(DependencyObject, Boolean) SetIsScrollInertiaEnabled(DependencyObject, Boolean)

Sets the value of the IsScrollInertiaEnabled dependency property / ScrollViewer.IsScrollInertiaEnabled XAML attached property on a specified element.

public : static void SetIsScrollInertiaEnabled(DependencyObject element, bool isScrollInertiaEnabled)
void SetIsScrollInertiaEnabled(DependencyObject element, bool isScrollInertiaEnabled) const;
public static void SetIsScrollInertiaEnabled(DependencyObject element, Boolean isScrollInertiaEnabled)
Public Static Function SetIsScrollInertiaEnabled(element As DependencyObject, isScrollInertiaEnabled As Boolean) As void
Parameters
element
DependencyObject DependencyObject

The element on which to set the property value.

isScrollInertiaEnabled
Boolean Boolean

The value to set.

Remarks

For more info, see the IsScrollInertiaEnabled property.

See Also

SetIsTemplateFocusTarget(FrameworkElement,Boolean) SetIsTemplateFocusTarget(FrameworkElement,Boolean) SetIsTemplateFocusTarget(FrameworkElement,Boolean) SetIsTemplateFocusTarget(FrameworkElement,Boolean)

Sets the value of the Control.IsTemplateFocusTarget XAML attached property for a target element.

(Inherited from Control)

SetIsTemplateKeyTipTarget(DependencyObject,Boolean) SetIsTemplateKeyTipTarget(DependencyObject,Boolean) SetIsTemplateKeyTipTarget(DependencyObject,Boolean) SetIsTemplateKeyTipTarget(DependencyObject,Boolean)

Sets the value of the Control.IsTemplateKeyTipTarget XAML attached property for a target element.

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

SetIsVerticalRailEnabled(DependencyObject, Boolean) SetIsVerticalRailEnabled(DependencyObject, Boolean) SetIsVerticalRailEnabled(DependencyObject, Boolean) SetIsVerticalRailEnabled(DependencyObject, Boolean)

Sets the value of the IsVerticalRailEnabled dependency property / ScrollViewer.IsVerticalRailEnabled XAML attached property on a specified element.

public : static void SetIsVerticalRailEnabled(DependencyObject element, bool isVerticalRailEnabled)
void SetIsVerticalRailEnabled(DependencyObject element, bool isVerticalRailEnabled) const;
public static void SetIsVerticalRailEnabled(DependencyObject element, Boolean isVerticalRailEnabled)
Public Static Function SetIsVerticalRailEnabled(element As DependencyObject, isVerticalRailEnabled As Boolean) As void
Parameters
element
DependencyObject DependencyObject

The element on which to set the property value.

isVerticalRailEnabled
Boolean Boolean

The value to set.

Remarks

For more info, see the IsVerticalRailEnabled property.

See Also

SetIsVerticalScrollChainingEnabled(DependencyObject, Boolean) SetIsVerticalScrollChainingEnabled(DependencyObject, Boolean) SetIsVerticalScrollChainingEnabled(DependencyObject, Boolean) SetIsVerticalScrollChainingEnabled(DependencyObject, Boolean)

Sets the value of the IsVerticalScrollChainingEnabled dependency property / ScrollViewer.IsVerticalScrollChainingEnabled XAML attached property on a specified element.

public : static void SetIsVerticalScrollChainingEnabled(DependencyObject element, bool isVerticalScrollChainingEnabled)
void SetIsVerticalScrollChainingEnabled(DependencyObject element, bool isVerticalScrollChainingEnabled) const;
public static void SetIsVerticalScrollChainingEnabled(DependencyObject element, Boolean isVerticalScrollChainingEnabled)
Public Static Function SetIsVerticalScrollChainingEnabled(element As DependencyObject, isVerticalScrollChainingEnabled As Boolean) As void
Parameters
element
DependencyObject DependencyObject

The element on which to set the property value.

isVerticalScrollChainingEnabled
Boolean Boolean

The value to set.

Remarks

For more info, see the IsVerticalScrollChainingEnabled property.

See Also

SetIsZoomChainingEnabled(DependencyObject, Boolean) SetIsZoomChainingEnabled(DependencyObject, Boolean) SetIsZoomChainingEnabled(DependencyObject, Boolean) SetIsZoomChainingEnabled(DependencyObject, Boolean)

Sets the value of the IsZoomChainingEnabled dependency property / ScrollViewer.IsZoomChainingEnabled XAML attached property on a specified element.

public : static void SetIsZoomChainingEnabled(DependencyObject element, bool isZoomChainingEnabled)
void SetIsZoomChainingEnabled(DependencyObject element, bool isZoomChainingEnabled) const;
public static void SetIsZoomChainingEnabled(DependencyObject element, Boolean isZoomChainingEnabled)
Public Static Function SetIsZoomChainingEnabled(element As DependencyObject, isZoomChainingEnabled As Boolean) As void
Parameters
element
DependencyObject DependencyObject

The element on which to set the property value.

isZoomChainingEnabled
Boolean Boolean

The value to set.

Remarks

For more info, see the IsZoomChainingEnabled property.

See Also

SetIsZoomInertiaEnabled(DependencyObject, Boolean) SetIsZoomInertiaEnabled(DependencyObject, Boolean) SetIsZoomInertiaEnabled(DependencyObject, Boolean) SetIsZoomInertiaEnabled(DependencyObject, Boolean)

Sets the value of the IsZoomInertiaEnabled dependency property / ScrollViewer.IsZoomInertiaEnabled XAML attached property on a specified element.

public : static void SetIsZoomInertiaEnabled(DependencyObject element, bool isZoomInertiaEnabled)
void SetIsZoomInertiaEnabled(DependencyObject element, bool isZoomInertiaEnabled) const;
public static void SetIsZoomInertiaEnabled(DependencyObject element, Boolean isZoomInertiaEnabled)
Public Static Function SetIsZoomInertiaEnabled(element As DependencyObject, isZoomInertiaEnabled As Boolean) As void
Parameters
element
DependencyObject DependencyObject

The element on which to set the property value.

isZoomInertiaEnabled
Boolean Boolean

The value to set.

Remarks

For more info, see the IsZoomInertiaEnabled property.

See Also

SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object)

Sets the local value of a dependency property on a DependencyObject.

(Inherited from DependencyObject)

SetVerticalScrollBarVisibility(DependencyObject, ScrollBarVisibility) SetVerticalScrollBarVisibility(DependencyObject, ScrollBarVisibility) SetVerticalScrollBarVisibility(DependencyObject, ScrollBarVisibility) SetVerticalScrollBarVisibility(DependencyObject, ScrollBarVisibility)

Sets the value of the VerticalScrollBarVisibility dependency property / ScrollViewer.VerticalScrollBarVisibility XAML attached property on a specified element.

public : static void SetVerticalScrollBarVisibility(DependencyObject element, ScrollBarVisibility verticalScrollBarVisibility)
void SetVerticalScrollBarVisibility(DependencyObject element, ScrollBarVisibility verticalScrollBarVisibility) const;
public static void SetVerticalScrollBarVisibility(DependencyObject element, ScrollBarVisibility verticalScrollBarVisibility)
Public Static Function SetVerticalScrollBarVisibility(element As DependencyObject, verticalScrollBarVisibility As ScrollBarVisibility) As void
Parameters
element
DependencyObject DependencyObject

The element on which to set the property value.

verticalScrollBarVisibility
ScrollBarVisibility ScrollBarVisibility

The value to set.

Remarks

For more info, see the VerticalScrollBarVisibility property.

See Also

SetVerticalScrollMode(DependencyObject, ScrollMode) SetVerticalScrollMode(DependencyObject, ScrollMode) SetVerticalScrollMode(DependencyObject, ScrollMode) SetVerticalScrollMode(DependencyObject, ScrollMode)

Sets the value of the VerticalScrollMode dependency property / ScrollViewer.VerticalScrollMode XAML attached property on a specified element.

public : static void SetVerticalScrollMode(DependencyObject element, ScrollMode verticalScrollMode)
void SetVerticalScrollMode(DependencyObject element, ScrollMode verticalScrollMode) const;
public static void SetVerticalScrollMode(DependencyObject element, ScrollMode verticalScrollMode)
Public Static Function SetVerticalScrollMode(element As DependencyObject, verticalScrollMode As ScrollMode) As void
Parameters
element
DependencyObject DependencyObject

The element on which to set the property value.

verticalScrollMode
ScrollMode ScrollMode

The value to set.

Remarks

For more info, see the VerticalScrollMode property.

See Also

SetZoomMode(DependencyObject, ZoomMode) SetZoomMode(DependencyObject, ZoomMode) SetZoomMode(DependencyObject, ZoomMode) SetZoomMode(DependencyObject, ZoomMode)

Sets the value of the ZoomMode dependency property / ScrollViewer.ZoomMode XAML attached property on a specified element.

public : static void SetZoomMode(DependencyObject element, ZoomMode zoomMode)
void SetZoomMode(DependencyObject element, ZoomMode zoomMode) const;
public static void SetZoomMode(DependencyObject element, ZoomMode zoomMode)
Public Static Function SetZoomMode(element As DependencyObject, zoomMode As ZoomMode) As void
Parameters
element
DependencyObject DependencyObject

The element on which to set the property value.

zoomMode
ZoomMode ZoomMode

The value to set.

Remarks

For more info, see the ZoomMode property.

See Also

StartBringIntoView StartBringIntoView StartBringIntoView StartBringIntoView

Initiates a request to the XAML framework to bring the element into view within any scrollable regions it is contained within.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

StartBringIntoView(BringIntoViewOptions) StartBringIntoView(BringIntoViewOptions) StartBringIntoView(BringIntoViewOptions) StartBringIntoView(BringIntoViewOptions)

Initiates a request to the XAML framework to bring the element into view using the specified options.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

StartDragAsync(PointerPoint) StartDragAsync(PointerPoint) StartDragAsync(PointerPoint) StartDragAsync(PointerPoint)

Initiates a drag-and-drop operation.

(Inherited from UIElement)

TransformToVisual(UIElement) TransformToVisual(UIElement) TransformToVisual(UIElement) TransformToVisual(UIElement)

Returns a transform object that can be used to transform coordinates from the UIElement to the specified object.

(Inherited from UIElement)

TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs)

Attempts to invoke a keyboard shortcut (or accelerator) by searching the entire visual tree of the UIElement for the shortcut.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

TryStartDirectManipulation(Pointer) TryStartDirectManipulation(Pointer) TryStartDirectManipulation(Pointer) TryStartDirectManipulation(Pointer)

Resumes direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement.

(Inherited from UIElement)

UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64)

Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback.

(Inherited from DependencyObject)

UpdateLayout UpdateLayout UpdateLayout UpdateLayout

Ensures that all positions of child objects of a UIElement are properly updated for layout.

(Inherited from UIElement)

ZoomToFactor(Single) ZoomToFactor(Single) ZoomToFactor(Single) ZoomToFactor(Single)

Note

ZoomToFactor may be altered or unavailable for releases after Windows 8.1. Instead, use ChangeView.

Sets the effective value of ZoomFactor.

public : void ZoomToFactor(float factor)
void ZoomToFactor(Single factor) const;
public void ZoomToFactor(Single factor)
Public Function ZoomToFactor(factor As Single) As void
Parameters
factor
Single Single

The zoom factor to set. The factors are based on a norm of 1.0, which represents no zoom applied. The values you can set are also influenced by current values for MinZoomFactor and MaxZoomFactor.

Events

AccessKeyDisplayDismissed AccessKeyDisplayDismissed AccessKeyDisplayDismissed AccessKeyDisplayDismissed

Occurs when the access key sequence is complete to notify controls that they should hide access key visuals.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AccessKeyDisplayRequested AccessKeyDisplayRequested AccessKeyDisplayRequested AccessKeyDisplayRequested

Occurs when the access key sequence is started to notify controls that they should show access key visuals.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AccessKeyInvoked AccessKeyInvoked AccessKeyInvoked AccessKeyInvoked

Occurs when a user completes an access key sequence to notify the element that the access key action should be invoked.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

ActualThemeChanged ActualThemeChanged ActualThemeChanged ActualThemeChanged

Occurs when the ActualTheme property value has changed.

(Inherited from FrameworkElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

BringIntoViewRequested BringIntoViewRequested BringIntoViewRequested BringIntoViewRequested

Prerelease. Occurs when StartBringIntoView is called on this element or one of its descendants.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.17095.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v6)

CharacterReceived CharacterReceived CharacterReceived CharacterReceived

Occurs when a single, composed character is received by the input queue.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

ContextCanceled ContextCanceled ContextCanceled ContextCanceled

Occurs when a context input gesture continues into a manipulation gesture, to notify the element that the context flyout should not be opened.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

ContextRequested ContextRequested ContextRequested ContextRequested

Occurs when the user has completed a context input gesture, such as a right-click.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

DataContextChanged DataContextChanged DataContextChanged DataContextChanged

Occurs when the value of the FrameworkElement.DataContext property changes.

(Inherited from FrameworkElement)

DirectManipulationCompleted DirectManipulationCompleted DirectManipulationCompleted DirectManipulationCompleted

Occurs when any direct manipulation of the ScrollViewer finishes.

public : event EventHandler DirectManipulationCompleted<Platform::Object>
// Register
event_token DirectManipulationCompleted(EventHandler<Platform::Object> const& handler) const;

// Revoke with event_token
void DirectManipulationCompleted(event_token const& cookie) const;

// Revoke with event_revoker
DirectManipulationCompleted_revoker DirectManipulationCompleted(auto_revoker_t, EventHandler<Platform::Object> const& handler) const;
public event EventHandler DirectManipulationCompleted<object>
Public Event EventHandler DirectManipulationCompleted( Of ( Of object ))

DirectManipulationStarted DirectManipulationStarted DirectManipulationStarted DirectManipulationStarted

Occurs when any direct manipulation of the ScrollViewer begins.

public : event EventHandler DirectManipulationStarted<Platform::Object>
// Register
event_token DirectManipulationStarted(EventHandler<Platform::Object> const& handler) const;

// Revoke with event_token
void DirectManipulationStarted(event_token const& cookie) const;

// Revoke with event_revoker
DirectManipulationStarted_revoker DirectManipulationStarted(auto_revoker_t, EventHandler<Platform::Object> const& handler) const;
public event EventHandler DirectManipulationStarted<object>
Public Event EventHandler DirectManipulationStarted( Of ( Of object ))

DoubleTapped DoubleTapped DoubleTapped DoubleTapped

Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element.

(Inherited from UIElement)

DragEnter DragEnter DragEnter DragEnter

Occurs when the input system reports an underlying drag event with this element as the target.

(Inherited from UIElement)

DragLeave DragLeave DragLeave DragLeave

Occurs when the input system reports an underlying drag event with this element as the origin.

(Inherited from UIElement)

DragOver DragOver DragOver DragOver

Occurs when the input system reports an underlying drag event with this element as the potential drop target.

(Inherited from UIElement)

DragStarting DragStarting DragStarting DragStarting

Occurs when a drag operation is initiated.

(Inherited from UIElement)

Drop Drop Drop Drop

Occurs when the input system reports an underlying drop event with this element as the drop target.

(Inherited from UIElement)

DropCompleted DropCompleted DropCompleted DropCompleted

Occurs when a drag-and-drop operation is ended.

(Inherited from UIElement)

FocusDisengaged FocusDisengaged FocusDisengaged FocusDisengaged

Occurs when focus is released from the control boundaries (for game pad/remote interaction).

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FocusEngaged FocusEngaged FocusEngaged FocusEngaged

Occurs when focus is constrained within the control boundaries (for game pad/remote interaction).

(Inherited from Control)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

GettingFocus GettingFocus GettingFocus GettingFocus

Occurs before a UIElement receives focus.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

GotFocus GotFocus GotFocus GotFocus

Occurs when a UIElement receives focus.

(Inherited from UIElement)

Holding Holding Holding Holding

Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element.

(Inherited from UIElement)

IsEnabledChanged IsEnabledChanged IsEnabledChanged IsEnabledChanged

Occurs when the IsEnabled property changes.

(Inherited from Control)

KeyDown KeyDown KeyDown KeyDown

Occurs when a keyboard key is pressed while the UIElement has focus.

(Inherited from UIElement)

KeyUp KeyUp KeyUp KeyUp

Occurs when a keyboard key is released while the UIElement has focus.

(Inherited from UIElement)

LayoutUpdated LayoutUpdated LayoutUpdated 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 Loaded Loaded Loaded

Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction.

(Inherited from FrameworkElement)

Loading Loading Loading Loading

Occurs when a FrameworkElement begins to load.

(Inherited from FrameworkElement)

LosingFocus LosingFocus LosingFocus LosingFocus

Occurs before a UIElement loses focus.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

LostFocus LostFocus LostFocus LostFocus

Occurs when a UIElement loses focus.

(Inherited from UIElement)

ManipulationCompleted ManipulationCompleted ManipulationCompleted ManipulationCompleted

Occurs when a manipulation on the UIElement is complete.

(Inherited from UIElement)

ManipulationDelta ManipulationDelta ManipulationDelta ManipulationDelta

Occurs when the input device changes position during a manipulation.

(Inherited from UIElement)

ManipulationInertiaStarting ManipulationInertiaStarting ManipulationInertiaStarting ManipulationInertiaStarting

Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins.

(Inherited from UIElement)

ManipulationStarted ManipulationStarted ManipulationStarted ManipulationStarted

Occurs when an input device begins a manipulation on the UIElement.

(Inherited from UIElement)

ManipulationStarting ManipulationStarting ManipulationStarting ManipulationStarting

Occurs when the manipulation processor is first created.

(Inherited from UIElement)

NoFocusCandidateFound NoFocusCandidateFound NoFocusCandidateFound NoFocusCandidateFound

Occurs when a user attempts to move focus (via tab or directional arrows), but focus doesn't move because no focus candidate is found in the direction of movement.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

PointerCanceled PointerCanceled PointerCanceled PointerCanceled

Occurs when a pointer that made contact abnormally loses contact.

(Inherited from UIElement)

PointerCaptureLost PointerCaptureLost PointerCaptureLost PointerCaptureLost

Occurs when pointer capture previously held by this element moves to another element or elsewhere.

(Inherited from UIElement)

PointerEntered PointerEntered PointerEntered PointerEntered

Occurs when a pointer enters the hit test area of this element.

(Inherited from UIElement)

PointerExited PointerExited PointerExited PointerExited

Occurs when a pointer leaves the hit test area of this element.

(Inherited from UIElement)

PointerMoved PointerMoved PointerMoved PointerMoved

Occurs when a pointer moves while the pointer remains within the hit test area of this element.

(Inherited from UIElement)

PointerPressed PointerPressed PointerPressed PointerPressed

Occurs when the pointer device initiates a Press action within this element.

(Inherited from UIElement)

PointerReleased PointerReleased PointerReleased PointerReleased

Occurs when the pointer device that previously initiated a Press action is released, while within this element. Note that the end of a Press action is not guaranteed to fire a PointerReleased event; other events may fire instead. For more info, see Remarks.

(Inherited from UIElement)

PointerWheelChanged PointerWheelChanged PointerWheelChanged PointerWheelChanged

Occurs when the delta value of a pointer wheel changes.

(Inherited from UIElement)

PreviewKeyDown PreviewKeyDown PreviewKeyDown PreviewKeyDown

Occurs when a keyboard key is pressed while the UIElement has focus.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

PreviewKeyUp PreviewKeyUp PreviewKeyUp PreviewKeyUp

Occurs when a keyboard key is released while the UIElement has focus.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

ProcessKeyboardAccelerators ProcessKeyboardAccelerators ProcessKeyboardAccelerators ProcessKeyboardAccelerators

Occurs when a keyboard shortcut (or accelerator) is pressed.

(Inherited from UIElement)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

RightTapped RightTapped RightTapped RightTapped

Occurs when a right-tap input stimulus happens while the pointer is over the element.

(Inherited from UIElement)

SizeChanged SizeChanged SizeChanged SizeChanged

Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement.

(Inherited from FrameworkElement)

Tapped Tapped Tapped Tapped

Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element.

(Inherited from UIElement)

Unloaded Unloaded Unloaded Unloaded

Occurs when this object is no longer connected to the main object tree.

(Inherited from FrameworkElement)

ViewChanged ViewChanged ViewChanged ViewChanged

Occurs when manipulations such as scrolling and zooming have caused the view to change.

public : event EventHandler ViewChanged<ScrollViewerViewChangedEventArgs>
// Register
event_token ViewChanged(EventHandler<ScrollViewerViewChangedEventArgs> const& handler) const;

// Revoke with event_token
void ViewChanged(event_token const& cookie) const;

// Revoke with event_revoker
ViewChanged_revoker ViewChanged(auto_revoker_t, EventHandler<ScrollViewerViewChangedEventArgs> const& handler) const;
public event EventHandler ViewChanged<ScrollViewerViewChangedEventArgs>
Public Event EventHandler ViewChanged( Of ( Of ScrollViewerViewChangedEventArgs ))
<ScrollViewer ViewChanged="eventhandler"/>

Remarks

ViewChanging fires before ViewChanged.

In your event handler, use a parameter of type ScrollViewerViewChangedEventArgs for the second parameter of your handler method. ScrollViewerViewChangedEventArgs includes the IsIntermediate property, which reports whether the manipulation that fired the event is completed or still ongoing.

Not every underlying manipulation will necessarily fire this event. The class logic delays and consolidates intermediate events into a single occurrence in some cases.

See Also

ViewChanging ViewChanging ViewChanging ViewChanging

Occurs when manipulations such as scrolling and zooming cause the view to change.

public : event EventHandler ViewChanging<ScrollViewerViewChangingEventArgs>
// Register
event_token ViewChanging(EventHandler<ScrollViewerViewChangingEventArgs> const& handler) const;

// Revoke with event_token
void ViewChanging(event_token const& cookie) const;

// Revoke with event_revoker
ViewChanging_revoker ViewChanging(auto_revoker_t, EventHandler<ScrollViewerViewChangingEventArgs> const& handler) const;
public event EventHandler ViewChanging<ScrollViewerViewChangingEventArgs>
Public Event EventHandler ViewChanging( Of ( Of ScrollViewerViewChangingEventArgs ))
<ScrollViewer ViewChanging="eventhandler"/>

Remarks

ScrollViewerViewChangingEventArgs includes the IsInertial property, which reports whether the manipulation that is firing the event contains an inertial component.

Not every underlying manipulation will necessarily fire this event. The ScrollViewer logic delays and consolidates intermediate events into a single occurrence in some cases.

See Also