IScroller Methods

ResetState

Resets the state of the scroller to Unknown. Should be called when the content is scrolled without interacting with the IScroller (e.g. adding new items to a list). Ensures on next interaction the scroller checks the state.

Syntax:

void ResetState()

ScrollLineDown

Scrolls down by the smallest increment, to show the next line of the scrollable content. Typically by clicking once on the scroll down button.

Syntax:

void ScrollLineDown(
	int numberOfLines = 1
)

Parameters:

Parameter

Description

[numberOfLines]

Type: Int32 The number of lines or increments to scroll down.

ScrollLineUp

Scrolls up by the smallest increment, to show the previous line of the scrollable content. Typically by clicking once on the scroll up button.

Syntax:

void ScrollLineUp(
	int numberOfLines = 1
)

Parameters:

Parameter

Description

[numberOfLines]

Type: Int32 The number of lines or increments to scroll down.

ScrollPageDown

Scrolls down by a larger amount, to show the next page of the scrollable content. Typically by clicking PageDown Key or by clicking just above the scroll down button.

Syntax:

void ScrollPageDown()

ScrollPageUp

Scrolls up by a larger amount, to show the previous page of the scrollable content. Typically by clicking PageUp Key or by clicking just below the scroll up button.

Syntax:

void ScrollPageUp()

ScrollToBottom

Scrolls all the way to the bottom of the scrollable content. IsAtBottom should be true after this.

Syntax:

void ScrollToBottom()

ScrollToTop

Scrolls all the way to the top of the scrollable content. IsAtTop should be true after this.

Syntax:

void ScrollToTop()

ScrollWheelDown

Scrolls down using the Mouse.ScrollWheel which typically moves the scrollable content by three lines.

Syntax:

void ScrollWheelDown(
	int increments
)

Parameters:

Parameter

Description

increments

Type: Int32 The number of increments to turn the scroll wheel.

ScrollWheelUp

Scrolls up using the Mouse.ScrollWheel which typically moves the scrollable content by three lines.

Syntax:

void ScrollWheelUp(
	int increments
)

Parameters:

Parameter

Description

increments

Type: Int32 The number of increments to turn the scroll wheel.

Last updated