DgsGridListClear: Difference between revisions

Latest revision as of 14:19, 27 January 2019

This function clears all the data from a dgs grid list.

Syntax

bool dgsGridListClear ( element gridList [, bool clearRow = true, bool clearColumn = false ] )

Required Arguments

gridList: The dgs grid list element to be cleared.

Optional Arguments

clearRow: Set to true to clear the rows.
clearColumn: Set to true to clear the columns.

Returns

Returns true if the grid list element is valid and has been cleared successfully, false otherwise.

Example

This example creates a grid list, puts 2 items in to display the text "Hello" and "world" and clears the grid list after 5 seconds.

DGS = exports.dgs
function clientsideResourceStart ()
        -- Create the grid list element
	local testList = DGS:dgsCreateGridList ( 0.45, 0.45, 0.15, 0.15, true ) 
        -- Create a column in the list and add 2 rows displaying "Hello" text and "world" text
	local column = DGS:dgsGridListAddColumn( testList, "test", 0.85 ) 
	DGS:dgsGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "Hello" )
	DGS:dgsGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "World" )
        -- Set a timer to call the dgsGridListClear function to clear the grid list items in 5 seconds
	setTimer ( DGS:dgsGridListClear, 5000, 1, testList ) 
end
addEventHandler ( "onClientResourceStart", resourceRoot, clientsideResourceStart )

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

dgsCreateBrowser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

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

dgsCreateCanvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

@@ Line 5: / Line 5: @@
 ==Syntax==
 <syntaxhighlight lang="lua">
-bool dgsGridListClear ( element gridList )
+bool dgsGridListClear ( element gridList [, bool clearRow = true, bool clearColumn = false ] )
 </syntaxhighlight>
 ===Required Arguments===
-*'''gridList:''' The dgs grid list element to be cleared
+*'''gridList:''' The dgs grid list element to be cleared.
+===Optional Arguments===
+*'''clearRow:'''  Set to true to clear the rows.
+*'''clearColumn:''' Set to true to clear the columns.
 ===Returns===