Interface IScrollInfo

Namespace

Stride.UI

Assembly

Stride.UI.dll

Represents the main scrollable region inside a ScrollViewer control.

public interface IScrollInfo

Properties

Extent

Gets the size of the extent. That is the virtual total size of the UIElement.

Vector3 Extent { get; }

Property Value

Vector3

Offset

Gets the offset of the scrolled content.

Vector3 Offset { get; }

Property Value

Vector3

ScrollBarPositions

Get the position of the horizontal, vertical and in depth scroll bars.

Vector3 ScrollBarPositions { get; }

Property Value

Vector3

A value between 0 and 1 for each component indicating the position of the scroll bar

Remarks

Return 0 for each direction the element cannot scroll

ScrollOwner

Gets or sets a ScrollViewer element that controls scrolling behavior.

ScrollViewer ScrollOwner { get; set; }

Property Value

ScrollViewer

Viewport

Gets the size of the viewport for this content.

Vector3 Viewport { get; }

Property Value

Vector3

Methods

CanScroll(Orientation)

Gets a value that indicates if the UIElement can scroll in the provided direction.

bool CanScroll(Orientation direction)

Parameters

direction Orientation

The direction in which perform the scrolling

Returns

bool

ScrollOf(Vector3)

Increase the amount of offset from the current scrolling position.

void ScrollOf(Vector3 offsets)

Parameters

offsets Vector3

ScrollToBeginning(Orientation)

Go to the beginning of the element in the given the direction.

void ScrollToBeginning(Orientation direction)

Parameters

direction Orientation

The direction in which to scroll

ScrollToEnd(Orientation)

Go to the end of the element in the given the direction.

void ScrollToEnd(Orientation direction)

Parameters

direction Orientation

The direction in which to scroll

ScrollToNextLine(Orientation)

Go to the next line in the given the direction.

void ScrollToNextLine(Orientation direction)

Parameters

direction Orientation

The direction in which to scroll

ScrollToNextPage(Orientation)

Go to the next page in the given the direction.

void ScrollToNextPage(Orientation direction)

Parameters

direction Orientation

The direction in which to scroll

ScrollToPreviousLine(Orientation)

Go to the previous line in the given the direction.

void ScrollToPreviousLine(Orientation direction)

Parameters

direction Orientation

The direction in which to scroll

ScrollToPreviousPage(Orientation)

Go to the previous page in the given the direction.

void ScrollToPreviousPage(Orientation direction)

Parameters

direction Orientation

The direction in which to scroll