guiGridListGetVerticalScrollPosition

Client-side

Server-side

Shared

Pair: guiGridListSetVerticalScrollPosition

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

OOP Syntax Help! I don't understand this!

Method:gui-gridlist:getVerticalScrollPosition(...)
Variable: .verticalScrollPosition

Syntax

float|false guiGridListGetVerticalScrollPosition ( gui-gridlist guiGridlist )

Required arguments

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

Returns

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

float|false: scroll vertical position

Code Examples

client

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

local gridList = guiCreateGridList(0.80, 0.10, 0.15, 0.60, true) -- Create the grid list
local column = guiGridListAddColumn(gridList, "New column", 1) -- Create a new column in the grid list

for i = 1, 30 do
    guiGridListAddRow(gridList, "Item "..tostring(i))
end

if gridList then -- if the grid list exist then
    guiGridListSetVerticalScrollPosition(gridList, 25)

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

guiGridListGetVerticalScrollPosition

OOP Syntax Help! I don't understand this!

Syntax

Required arguments

Returns

Code Examples

See Also

GUI Functions

GUI Elements

Reference