Interface IScrollProvider

Namespace

Avalonia.Automation.Provider

Assembly

Avalonia.Controls.dll

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.

public interface IScrollProvider

Properties

HorizontalScrollPercent

Gets the current horizontal scroll position.

double HorizontalScrollPercent { get; }

Property Value

double

Remarks

Windows	IScrollProvider.HorizontalScrollPercent
macOS	No mapping.

HorizontalViewSize

Gets the current horizontal view size.

double HorizontalViewSize { get; }

Property Value

double

Remarks

Windows	IScrollProvider.HorizontalViewSize
macOS	No mapping.

HorizontallyScrollable

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

bool HorizontallyScrollable { get; }

Property Value

bool

Remarks

Windows	IScrollProvider.HorizontallyScrollable
macOS	No mapping.

VerticalScrollPercent

Gets the current vertical scroll position.

double VerticalScrollPercent { get; }

Property Value

double

Remarks

Windows	IScrollProvider.VerticalScrollPercent
macOS	No mapping.

VerticalViewSize

Gets the vertical view size.

double VerticalViewSize { get; }

Property Value

double

Remarks

Windows	IScrollProvider.VerticalViewSize
macOS	No mapping.

VerticallyScrollable

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

bool VerticallyScrollable { get; }

Property Value

bool

Remarks

Windows	IScrollProvider.VerticallyScrollable
macOS	No mapping.

Methods

Scroll(ScrollAmount, ScrollAmount)

Scrolls the visible region of the content area horizontally and vertically.

void Scroll(ScrollAmount horizontalAmount, ScrollAmount verticalAmount)

Parameters

horizontalAmount ScrollAmount

The horizontal increment specific to the control.

verticalAmount ScrollAmount

The vertical increment specific to the control.

Remarks

Windows	IScrollProvider.Scroll
macOS	No mapping.

SetScrollPercent(double, double)

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

void SetScrollPercent(double horizontalPercent, double verticalPercent)

Parameters

horizontalPercent double

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

verticalPercent double

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

Remarks

Windows	IScrollProvider.SetScrollPercent
macOS	No mapping.