guiGridListGetHorizontalScrollPosition

Client-side

Server-side

Shared

Pair: guiGridListSetHorizontalScrollPosition

This function is used to get the horizontal scroll position from a grid list.

OOP Syntax Help! I don't understand this!

Method:gui-gridlist:getHorizontalScrollPosition(...)
Variable: .horizontalScrollPosition

Syntax

float|false guiGridListGetHorizontalScrollPosition ( gui-gridlist guiGridlist )

Required arguments

guiGridlist: The grid list you want to get the horizontal scroll position from.

Returns

Returns a integer between 0 and 100 indicating the horizontal scroll position, or false otherwise.

float|false: scroll horizontal position

Code Examples

client

This example gets the position of the horizontal scroll and outputs it to the chatbox.

local gridList = guiCreateGridList(0.80, 0.10, 0.15, 0.60, true) -- Create the grid list

for i = 1,4 do
    guiGridListAddColumn(gridList, "Column "..tostring(i), 0.8) -- Create a new column in the grid list
end

for i = 1,30 do
    local text = "Item "..tostring(i)
    guiGridListAddRow(gridList, "#1 "..text, "#2 "..text, "#3 "..text, "#4 "..text)
end

if gridList then -- if the grid list exist then
    local postion = guiGridListGetHorizontalScrollPosition(gridList) -- get the horizontal scroll position
    outputChatBox("Current position of the horizontal scroll:" .. tostring(position) .. "%") -- output to the chatbox
else
    outputChatBox("Grid list not found!") -- if the grid list was not found
end

guiGridListGetHorizontalScrollPosition

OOP Syntax Help! I don't understand this!

Syntax

Required arguments

Returns

Code Examples

See Also

GUI Functions

GUI Elements

Reference