IScrollProvider IScrollProvider IScrollProvider IScrollProvider Interface

Definition

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 call and PatternInterface.Scroll.

public : interface IScrollProvider
struct winrt::Windows::UI::Xaml::Automation::Provider::IScrollProvider
public interface IScrollProvider
Public Interface IScrollProvider
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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.

Properties

HorizontallyScrollable HorizontallyScrollable HorizontallyScrollable HorizontallyScrollable

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

HorizontalScrollPercent HorizontalScrollPercent HorizontalScrollPercent HorizontalScrollPercent

Gets the current horizontal scroll position.

HorizontalViewSize HorizontalViewSize HorizontalViewSize HorizontalViewSize

Gets the current horizontal view size.

VerticallyScrollable VerticallyScrollable VerticallyScrollable VerticallyScrollable

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

VerticalScrollPercent VerticalScrollPercent VerticalScrollPercent VerticalScrollPercent

Gets the current vertical scroll position.

VerticalViewSize VerticalViewSize VerticalViewSize VerticalViewSize

Gets the vertical view size.

Methods

Scroll(ScrollAmount, ScrollAmount) Scroll(ScrollAmount, ScrollAmount) Scroll(ScrollAmount, ScrollAmount) Scroll(ScrollAmount, ScrollAmount)

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

SetScrollPercent(Double, Double) SetScrollPercent(Double, Double) SetScrollPercent(Double, Double) SetScrollPercent(Double, Double)

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

See also