Thisdp: /* Syntax */

2019-08-16T11:08:11Z

Syntax

← Older revision		Revision as of 11:08, 16 August 2019
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool dgsScrollPaneSetVerticalScrollPosition ( element ~~verticalScrollPane~~, float position )		bool dgsScrollPaneSetVerticalScrollPosition ( element dgsScrollPane, float position )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''~~verticalScrollPane~~''': The scroll pane you want to change the position of		*'''dgsScrollPane''': The scroll pane you want to change the position of
	*'''position''': a float ranging from 0 - 100		*'''position''': a float ranging from 0 - 100

XLive: Created page with "{{client function}} This function is used to set the position of a vertical scroll pane as a percentage. ==Syntax== bool dgsScrollPaneSetVertical..."

2019-08-16T11:04:30Z

Created page with "{{client function}} This function is used to set the position of a vertical scroll pane as a percentage. ==Syntax== <syntaxhighlight lang="lua"> bool dgsScrollPaneSetVertical..."

New page

{{client function}}
This function is used to set the position of a vertical scroll pane as a percentage.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsScrollPaneSetVerticalScrollPosition ( element verticalScrollPane, float position )
</syntaxhighlight>

===Required Arguments===
*'''verticalScrollPane''': 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 [[dgsCreateScrollPane]], and outputs it to the chatbox.
<syntaxhighlight lang="lua">
DGS = exports.dgs

if ( myScrollPane ) then -- if the scroll pane exist then
-- set the position
DGS:dgsScrollPaneSetVerticalScrollPosition( myScrollPane, 33.3 ) -- 1/3 from the upside
-- get the position
local position = DGS:dgsScrollPaneGetVerticalScrollPosition( 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
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsScrollPaneSetVerticalScrollPosition - Revision history

Thisdp: /* Syntax */

XLive: Created page with "{{client function}} This function is used to set the position of a vertical scroll pane as a percentage. ==Syntax== bool dgsScrollPaneSetVertical..."