API:HorizontalScrollbarGetLineSize

UI Lua API · Scrollbar functions
Version: WAR 1.4.8

Returns the line size of a HorizontalScrollbar.

lineSize = HorizontalScrollbarGetLineSize(scrollbarName)

Arguments

scrollbarName

string – Name of the HorizontalScrollbar.

Returns

lineSize

number – The stored line size.

Details

• HorizontalScrollbarSetLineSize does not set this value; HorizontalScrollbarSetPageSize does (see those pages).
• The stock UI never calls this function.

Errors

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

Example

A minimal example built from the signature:

local lineSize = HorizontalScrollbarGetLineSize( "MyScrollbar" )

See also

• HorizontalScrollbarSetLineSize
• HorizontalScrollbarSetPageSize