GenericScroller Methods

LResetState

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 by clicking on the scroll down button. After each click the method waits for the thumb to move and at the end mouse is moved away from the Button (by the MoveApproachOffset) and the method waits for a stable screen in the SearchSelect area. If the scroller is inactive or already at the bottom, the method returns directly and does not attempt to scroll.

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 by clicking on the scroll up button. After each click the method waits for the thumb to move and at the end mouse is moved away from the Button (by the MoveApproachOffset) and the method waits for a stable screen in the SearchSelect area. If the scroller is inactive or already at the top, the method returns directly and does not attempt to scroll.

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 by clicking just above the scroll down button. At the end mouse is moved away from the Button (by the MoveApproachOffset) and the method waits for a stable screen in the SearchSelect area. If the scroller is inactive or already at the bottom, the method returns directly and does not attempt to scroll.

Syntax:

void ScrollPageDown()

ScrollPageUp

Scrolls up by a larger amount, to show the previous page of the scrollable content by clicking just below the scroll up button. At the end mouse is moved away from the Button (by the MoveApproachOffset) and the method waits for a stable screen in the SearchSelect area. If the scroller is inactive or already at the top, the method returns directly and does not attempt to scroll.

Syntax:

void ScrollPageUp()

ScrollToBottom

Scrolls all the way to the bottom of the scrollable content by pressing the mouse button just above the down button until the thumb does not move up any further. If the scroller is inactive or already at the bottom, the method returns directly and does not attempt to scroll.

Syntax:

void ScrollToBottom()

ScrollToTop

Scrolls all the way to the top of the scrollable content by pressing the mouse button just below the up button until the thumb does not move up any further. If the scroller is inactive or already at the top, the method returns directly and does not attempt to scroll.

Syntax:

void ScrollToTop()

ScrollWheelDown

Scrolls down using the Mouse.ScrollWheel which typically moves the scrollable content by three lines. The mouse is placed in the middle of the SearchSelect for the ScrollWheel to target the correct scroller. If the scroller is inactive, the method returns directly and does not attempt to scroll.

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. The mouse is placed in the middle of the SearchSelect for the ScrollWheel to target the correct scroller. If the scroller is inactive, the method returns directly and does not attempt to scroll.

Syntax:

void ScrollWheelUp(
	int increments
)

Parameters:

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