GuiGridListSetHorizontalScrollPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Missing example)
(Added example)
Line 1: Line 1:
{{Needs_Example}}
{{client function}}
{{client function}}
This function is used to set the horizontal scroll position from a grid list
This function is used to set the horizontal scroll position from a grid list
Line 19: Line 18:


==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}}

Revision as of 18:36, 3 July 2016

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

Syntax

bool guiGridListSetHorizontalScrollPosition ( element guiGridlist, float fPosition )

Required Arguments

  • guiGridlist: The grid list you want to set the horizontal scroll position from
  • fPosition: A float representing the horizontal scroll position (0-100)

Returns

Returns true if the horizontal scroll position was set, or false otherwise.

Requirements

Minimum server version n/a
Minimum client version 1.3.2

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3.2" />

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