DgsScrollPaneSetVerticalScrollPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(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...")
 
 
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



Latest revision as of 11:08, 16 August 2019

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

Syntax

bool dgsScrollPaneSetVerticalScrollPosition ( element dgsScrollPane, float position )

Required Arguments

  • dgsScrollPane: 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.

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

See Also

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips