API:HorizontalScrollbarGetPageSize

UI Lua API · Scrollbar functions
Version: WAR 1.4.8

Returns the page size of a HorizontalScrollbar.

pageSize = HorizontalScrollbarGetPageSize(scrollbarName)

Arguments

scrollbarName

string – Name of the HorizontalScrollbar.

Returns

pageSize

number – The page size: the part of the content that is visible at once.

Details

• The page size sets the length of the thumb relative to the maximum scroll position, and the highest reachable position is the maximum scroll position minus the page size.
• HorizontalScrollbarSetPageSize does not change this value; use HorizontalScrollbarSetLineSize (see that page).
• The stock UI never calls this function.

Errors

• Error in function call 'HorizontalScrollbarGetPageSize': Window %s does not exist
• Error in function call 'HorizontalScrollbarGetPageSize': Window %s is not a HorizontalScrollbar

Example

A minimal example built from the signature:

local pageSize = HorizontalScrollbarGetPageSize( "MyScrollbar" )

See also

• HorizontalScrollbarSetPageSize
• HorizontalScrollbarGetMaxScrollPosition