IScrollProvider IScrollProvider IScrollProvider Interface

Exposes methods and properties to support access by a Microsoft UI Automation client to a control that acts as a scrollable container for a collection of child objects. The children of this element must implement IScrollItemProvider. Implement IScrollProvider in order to support the capabilities that an automation client requests with a GetPattern(Windows.UI.Xaml.Automation.Peers.PatternInterface) call and PatternInterface.

Syntax

Declaration

public interface IScrollProviderpublic interface IScrollProviderPublic Interface IScrollProvider

Remarks

This pattern has guidelines and conventions that aren't fully documented here. For more info on what this pattern is for, see Scroll Control Pattern.

IScrollProvider is implemented by the existing Windows Runtime class ScrollViewerAutomationPeer, which is the peer for the ScrollViewer component part used in many other list controls.

Also, IScrollProvider is reported as a supported pattern by ItemsControlAutomationPeer, but only if a ScrollViewer exists in the owner's template and is active. The ScrollViewerAutomationPeer for this ScrollViewer provides the pattern implementation, ItemsControlAutomationPeer is only forwarding it.

Use ScrollPatternIdentifiers if you want to reference the IScrollProvider pattern properties from control code when you fire automation events or call RaisePropertyChangedEvent(Windows.UI.Xaml.Automation.AutomationProperty,System.Object,System.Object).

Properties summary

Gets a value that indicates whether the control can scroll horizontally.

Gets the current horizontal scroll position.

Gets the current horizontal view size.

Gets a value that indicates whether the control can scroll vertically.

Gets the current vertical scroll position.

Gets the vertical view size.

Methods summary

Scrolls the visible region of the content area horizontally, vertically, or both.

Sets the horizontal and vertical scroll position as a percentage of the total content area within the control.

Properties

  • HorizontallyScrollable
    HorizontallyScrollable
    HorizontallyScrollable
    HorizontallyScrollable

    Gets a value that indicates whether the control can scroll horizontally.

    public bool HorizontallyScrollable { get; }public bool HorizontallyScrollable { get; }Public ReadOnly Property HorizontallyScrollable As bool

    Property Value

    • bool
      bool
      bool

      true if the control can scroll horizontally; otherwise, false.

  • HorizontalScrollPercent
    HorizontalScrollPercent
    HorizontalScrollPercent
    HorizontalScrollPercent

    Gets the current horizontal scroll position.

    public double HorizontalScrollPercent { get; }public double HorizontalScrollPercent { get; }Public ReadOnly Property HorizontalScrollPercent As double

    Property Value

    • double
      double
      double

      The horizontal scroll position as a percentage of the total content area within the control.

  • HorizontalViewSize
    HorizontalViewSize
    HorizontalViewSize
    HorizontalViewSize

    Gets the current horizontal view size.

    public double HorizontalViewSize { get; }public double HorizontalViewSize { get; }Public ReadOnly Property HorizontalViewSize As double

    Property Value

    • double
      double
      double

      The horizontal size of the viewable region as a percentage of the total content area within the control.

  • VerticallyScrollable
    VerticallyScrollable
    VerticallyScrollable
    VerticallyScrollable

    Gets a value that indicates whether the control can scroll vertically.

    public bool VerticallyScrollable { get; }public bool VerticallyScrollable { get; }Public ReadOnly Property VerticallyScrollable As bool

    Property Value

    • bool
      bool
      bool

      true if the control can scroll vertically; otherwise, false.

  • VerticalScrollPercent
    VerticalScrollPercent
    VerticalScrollPercent
    VerticalScrollPercent

    Gets the current vertical scroll position.

    public double VerticalScrollPercent { get; }public double VerticalScrollPercent { get; }Public ReadOnly Property VerticalScrollPercent As double

    Property Value

    • double
      double
      double

      The vertical scroll position as a percentage of the total content area within the control.

  • VerticalViewSize
    VerticalViewSize
    VerticalViewSize
    VerticalViewSize

    Gets the vertical view size.

    public double VerticalViewSize { get; }public double VerticalViewSize { get; }Public ReadOnly Property VerticalViewSize As double

    Property Value

    • double
      double
      double

      The vertical size of the viewable region as a percentage of the total content area within the control.

Methods

  • Scroll(Windows.UI.Xaml.Automation.ScrollAmount,Windows.UI.Xaml.Automation.ScrollAmount)
    Scroll(Windows.UI.Xaml.Automation.ScrollAmount,Windows.UI.Xaml.Automation.ScrollAmount)
    Scroll(Windows.UI.Xaml.Automation.ScrollAmount,Windows.UI.Xaml.Automation.ScrollAmount)
    Scroll(Windows.UI.Xaml.Automation.ScrollAmount,Windows.UI.Xaml.Automation.ScrollAmount)

    Scrolls the visible region of the content area horizontally, vertically, or both.

    public void Scroll(Windows.UI.Xaml.Automation.ScrollAmount horizontalAmount,Windows.UI.Xaml.Automation.ScrollAmount verticalAmount)public void Scroll(Windows.UI.Xaml.Automation.ScrollAmount horizontalAmount,Windows.UI.Xaml.Automation.ScrollAmount verticalAmount)Public Function Scroll(horizontalAmount As Windows.UI.Xaml.Automation.ScrollAmount,verticalAmount As Windows.UI.Xaml.Automation.ScrollAmount) As void

    Parameters

  • SetScrollPercent(System.Double,System.Double)
    SetScrollPercent(System.Double,System.Double)
    SetScrollPercent(System.Double,System.Double)
    SetScrollPercent(System.Double,System.Double)

    Sets the horizontal and vertical scroll position as a percentage of the total content area within the control.

    public void SetScrollPercent(System.Double horizontalPercent,System.Double verticalPercent)public void SetScrollPercent(System.Double horizontalPercent,System.Double verticalPercent)Public Function SetScrollPercent(horizontalPercent As System.Double,verticalPercent As System.Double) As void

    Parameters

    • horizontalPercent
      System.Double
      System.Double
      System.Double

      The horizontal position as a percentage of the content area's total range. Pass NoScroll if the control cannot be scrolled in this direction.

    • verticalPercent
      System.Double
      System.Double
      System.Double

      The vertical position as a percentage of the content area's total range. Pass NoScroll if the control cannot be scrolled in this direction.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.WebHostHiddenAttribute
Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.GuidAttribute

Details

Assembly

Windows.UI.Xaml.Automation.Provider.dll