GuiGridListGetHorizontalScrollPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Remove obsolete Requirements section)
 
(6 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{client function}}
{{client function}}
{{New items|3.0152|1.3.2|
This function is used to get the horizontal scroll position from a grid list
This function is used to get the horizontal scroll position from a grid list
}}


==Syntax==
==Syntax==
Line 9: Line 6:
float guiGridListGetHorizontalScrollPosition( element guiGridlist )
float guiGridListGetHorizontalScrollPosition( element guiGridlist )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:getHorizontalScrollPosition|horizontalScrollPosition|guiGridListSetHorizontalScrollPosition}}


===Required Arguments===
===Required Arguments===
Line 14: Line 12:


===Returns===
===Returns===
Returns a float indicating the horizontal scroll position, or ''false'' otherwise.
Returns a integer between 0 and 100 indicating the horizontal scroll position, or ''false'' otherwise.
 
==Requirements==
{{Requirements|n/a|1.3.2}}


==Example==
==Example==
This example gets the position of the horizontal scroll and outputs it to the chatbox.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- Todo
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
 
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
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
{{GUI_events}}

Latest revision as of 17:09, 7 November 2024

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

Syntax

float guiGridListGetHorizontalScrollPosition( element guiGridlist )

OOP Syntax Help! I don't understand this!

Method: GuiGridList:getHorizontalScrollPosition(...)
Variable: .horizontalScrollPosition
Counterpart: guiGridListSetHorizontalScrollPosition


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.

Example

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
local column = guiGridListAddColumn(gridList, "New column", 1) -- Create a new column in the grid list

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

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

Input

GUI


Retrieved from "https://wiki.multitheftauto.com/wiki/GuiGridListGetHorizontalScrollPosition?oldid=81159"