DgsGridListGetScrollBar: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
This function retrieves the scroll bars of a DGS grid list.
This function gets two scroll bars of dgs grid list.
 
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
table dgsGridListGetScrollBar( element gridList )
table dgsGridListGetScrollBar( element gridList )
</syntaxhighlight>  
</syntaxhighlight>  
 
   
===Required Arguments===  
===Required Arguments===  
*'''gridList:''' The dgs grid list element to be got from.
*'''gridList:''' The DGS grid list element to retrieve the scroll bars from.
 
   
===Returns===
===Returns===
Returns a table which includes two scroll bars if scroll bars are got successfully, ''false'' otherwise.
This function returns a table containing the vertical and horizontal scroll bars of the specified DGS grid list. ''false'' otherwise.
 
   
==Example==  
==Example==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
DGS = exports.dgs
loadstring(exports.dgs:dgsImportFunction())()
 
   
function clientsideResourceStart ()
function clientsideResourceStart ()
        -- Create the grid list element
    -- Create the grid list element
local testList = DGS:dgsCreateGridList ( 0.45, 0.45, 0.15, 0.15, true )  
    local testList = dgsCreateGridList ( 0.45, 0.45, 0.15, 0.15, true )  
-- Get the Scroll Bar
    -- Force scroll bars to be visible
local scrollBars = DGS:dgsGridListGetScrollBar( theList )
    dgsGridListSetScrollBarState ( testList, true, true )
DGS:dgsSetVisible(scrollBars[1],true)
    -- Get the scorllbars of the grid list
    local scrollBars = dgsGridListGetScrollBar ( testList )
    -- Lock the vertical scroll bar
    dgsScrollBarSetLocked( scrollBars[1], true )
    -- Lock the horizontal scroll bar
    dgsScrollBarSetLocked( scrollBars[2], true )
end
end
addEventHandler ( "onClientResourceStart", resourceRoot, clientsideResourceStart )</syntaxhighlight>
addEventHandler ( "onClientResourceStart", resourceRoot, clientsideResourceStart )
 
</syntaxhighlight>
   
==See Also==
==See Also==
{{DGSFUNCTIONS}}
{{DGSFUNCTIONS}}

Latest revision as of 13:34, 15 April 2023

This function retrieves the scroll bars of a DGS grid list.

Syntax

table dgsGridListGetScrollBar( element gridList )

Required Arguments

  • gridList: The DGS grid list element to retrieve the scroll bars from.

Returns

This function returns a table containing the vertical and horizontal scroll bars of the specified DGS grid list. false otherwise.

Example

loadstring(exports.dgs:dgsImportFunction())()
    
function clientsideResourceStart ()
    -- Create the grid list element
    local testList = dgsCreateGridList ( 0.45, 0.45, 0.15, 0.15, true ) 
    -- Force scroll bars to be visible
    dgsGridListSetScrollBarState ( testList, true, true )
    -- Get the scorllbars of the grid list
    local scrollBars = dgsGridListGetScrollBar ( testList )
    -- Lock the vertical scroll bar
    dgsScrollBarSetLocked( scrollBars[1], true )
    -- Lock the horizontal scroll bar
    dgsScrollBarSetLocked( scrollBars[2], true )
end
addEventHandler ( "onClientResourceStart", resourceRoot, clientsideResourceStart )

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/DgsGridListGetScrollBar?oldid=76706"