Interface IScrollProvider

Exposes methods and properties to support access by a UI automation client to a control that acts as a scrollable container for a collection of child objects. The children of this control must implement IScrollItemProvider.

Namespace: System.Windows.Automation.Provider

Assembly: OpenSilver.dll

Syntax

public interface IScrollProvider

Properties

HorizontallyScrollable

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

Declaration

bool HorizontallyScrollable { get; }

Property Value

Type	Description
System.Boolean	true if the control can scroll horizontally; otherwise, false.

HorizontalScrollPercent

Gets the current horizontal scroll position.

Declaration

double HorizontalScrollPercent { get; }

Property Value

Type	Description
System.Double	The horizontal scroll position as a percentage of the total content area within the control.

HorizontalViewSize

Gets the current horizontal view size.

Declaration

double HorizontalViewSize { get; }

Property Value

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

VerticallyScrollable

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

Declaration

bool VerticallyScrollable { get; }

Property Value

Type	Description
System.Boolean	true if the control can scroll vertically; otherwise, false.

VerticalScrollPercent

Gets the current vertical scroll position.

Declaration

double VerticalScrollPercent { get; }

Property Value

Type	Description
System.Double	The vertical scroll position as a percentage of the total content area within the control.

VerticalViewSize

Gets the vertical view size.

Declaration

double VerticalViewSize { get; }

Property Value

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

Methods

Scroll(ScrollAmount, ScrollAmount)

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

Declaration

void Scroll(ScrollAmount horizontalAmount, ScrollAmount verticalAmount)

Parameters

Type	Name	Description
ScrollAmount	horizontalAmount	The horizontal increment that is specific to the control. Pass NoScroll if the control cannot be scrolled in this direction.
ScrollAmount	verticalAmount	The vertical increment that is specific to the control. Pass NoScroll if the control cannot be scrolled in this direction.

SetScrollPercent(Double, Double)

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

Declaration

void SetScrollPercent(double horizontalPercent, double verticalPercent)

Parameters

Type	Name	Description
System.Double	horizontalPercent	The horizontal position as a percentage of the content area's total range. Pass NoScroll if the control cannot be scrolled in this direction.
System.Double	verticalPercent	The vertical position as a percentage of the content area's total range. Pass NoScroll if the control cannot be scrolled in this direction.