DgsScrollBarGetCursorLength: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} This function gets the length of scroll bar cursor. ==Syntax== <syntaxhighlight lang="lua"> bool dgsScrollBarGetCursorLength( element scrollBa...")
 
 
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dgsScrollBarGetCursorLength( element scrollBar)
bool dgsScrollBarGetCursorLength( element scrollBar [, bool relative ] )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''scrollBar:''' The scroll bar whose cursor value is to be returned.
*'''scrollBar:''' The scroll bar whose cursor value is to be returned.
===Optional Arguments===
*'''relative:''' This is whether sizes and positioning are relative. If this is true, then all width,height floats must be between 0 and 1, representing sizes relative to the scroll bar.


===Returns===
===Returns===
Returns scroll bar cursor value
Returns an ''int'' or a ''float'' indicates the length of the cursor of the scroll bar, ''false'' otherwise.


==Example==  
==Example==  

Latest revision as of 11:32, 27 April 2020

This function gets the length of scroll bar cursor.

Syntax

bool dgsScrollBarGetCursorLength( element scrollBar [, bool relative ] )

Required Arguments

  • scrollBar: The scroll bar whose cursor value is to be returned.

Optional Arguments

  • relative: This is whether sizes and positioning are relative. If this is true, then all width,height floats must be between 0 and 1, representing sizes relative to the scroll bar.

Returns

Returns an int or a float indicates the length of the cursor of the scroll bar, false otherwise.

Example

DGS = exports.dgs 
addEventHandler("onClientResourceStart", resourceRoot, function()
	local scrollBar = DGS:dgsCreateScrollBar(0.29, 0.30, 0.44, 0.04, true, true)
	outputChatBox(DGS:dgsScrollBarGetCursorLength(scrollBar)) -- output cursor length
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

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsScrollBarGetCursorLength?oldid=66083"