DgsScrollPaneGetVerticalScrollPosition

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

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

Syntax

float dgsScrollPaneGetVerticalScrollPosition ( element dgsScrollPane )

Required Arguments

  • dgsScrollPane: The scroll pane you want to know the position of

Returns

Returns a float ranging between 0 and 100, or false otherwise.

Example

This example gets 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
        -- 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 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

Label

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Plugin

Blur Box

Color Picker

Canvas

Circle

Effect 3D

Gradient

Media Browser

Mask

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Rounded Rectangle

Screen Source