GuiScrollPaneSetHorizontalScrollPosition

From Multi Theft Auto: Wiki
Jump to navigation Jump to search

This function is used to set the position of a horizontal scroll pane as a percentage.

Syntax

bool guiScrollPaneSetHorizontalScrollPosition ( element horizontalScrollPane, float position )

Required Arguments

  • horizontalScrollPane: The scroll pane you want to change the position of
  • position: a float ranging from 0 - 100

Returns

Returns true if the position was set, false otherwise.

Example

This example sets the position of a scroll pane called "myScrollPane" created with guiCreateScrollPane, and outputs it to the chatbox.

if ( myScrollPane ) then -- if the scroll pane exist then
	-- set the position
        guiScrollPaneSetHorizontalScrollPosition( myScrollPane, 100 ) -- right end
        -- get the position
	local position = guiScrollPaneGetHorizontalScrollPosition( myScrollPane )
	-- output to the chatbox
	outputChatBox ( "Current position of scroll pane:" .. tostring(position) .. "%" )
else -- if the scroll pane was not found
       outputChatBox ("scroll pane not found!")
end

See Also

General functions

* FEATURE ADDED IN 1.5.9 (REVISION: r21476)
* FEATURE ADDED IN 1.5.9 (REVISION: r21476)

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

Input

GUI