DgsGridListAddRow: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
Adds a row to a grid list, and optionally add simple text items with your rows.  Use [[dgsDxGridListSetItemText]] to add row headers.
Adds a row to a grid list, and optionally add simple text items with your rows.  Use [[dgsGridListSetItemText]] to add row headers.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int dgsDxGridListAddRow ( element gridList [,int pos, int/string itemText1, int/string itemText2, ...] )
int dgsGridListAddRow ( element gridList [,int pos, int/string itemText1, int/string itemText2, ...] )
</syntaxhighlight>
</syntaxhighlight>


===Required Arguments===  
===Required Arguments===  
*'''gridList:''' The grid list you want to add a row to.
*'''gridList:''' The grid list you want to add a row to.
*'''pos:''' Row ID of the row you want to insert the new row at (different from guiGridListInsertRowAfter).
 
===Optional Arguments===
*'''pos:''' Row ID of the row you want to insert the new row at (different from [[guiGridListInsertRowAfter]]).
*'''itemText1''': The text for the first column item in the row. Either a string or a number can be passed.
*'''itemText1''': The text for the first column item in the row. Either a string or a number can be passed.
*'''itemText2''': The text for the second column item in the row. Either a string or a number can be passed.
*'''itemText2''': The text for the second column item in the row. Either a string or a number can be passed.
*'''...''': Item text for any other columns
*'''...''': Item text for any other columns


===Returns===
===Returns===
Line 24: Line 25:
function createPlayerList ()
function createPlayerList ()
--Create the grid list element
--Create the grid list element
local playerList = DGS:dgsDxCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
local playerList = DGS:dgsCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
--Create a players column in the list
--Create a players column in the list
local column = DGS:dgsDxGridListAddColumn( playerList, "Player", 0.85 )
local column = DGS:dgsGridListAddColumn( playerList, "Player", 0.85 )
if ( column ) then --If the column has been created, fill it with players
if ( column ) then --If the column has been created, fill it with players
for id, player in ipairs(getElementsByType("player")) do
for id, player in ipairs(getElementsByType("player")) do
local row = DGS:dgsDxGridListAddRow ( playerList )
local row = DGS:dgsGridListAddRow ( playerList )
DGS:dgsDxGridListSetItemText ( playerList, row, column, getPlayerName ( player ), false, false )
DGS:dgsGridListSetItemText ( playerList, row, column, getPlayerName ( player ) )
end
end
end
end
end
end
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{DGSFUNCTIONS}}
{{DGSFUNCTIONS}}

Latest revision as of 03:25, 19 July 2018

Adds a row to a grid list, and optionally add simple text items with your rows. Use dgsGridListSetItemText to add row headers.

Syntax

int dgsGridListAddRow ( element gridList [,int pos, int/string itemText1, int/string itemText2, ...] )

Required Arguments

  • gridList: The grid list you want to add a row to.

Optional Arguments

  • pos: Row ID of the row you want to insert the new row at (different from guiGridListInsertRowAfter).
  • itemText1: The text for the first column item in the row. Either a string or a number can be passed.
  • itemText2: The text for the second column item in the row. Either a string or a number can be passed.
  • ...: Item text for any other columns

Returns

Returns the row id if it has been created, false otherwise.

Example

DGS = exports.dgs
function createPlayerList ()
	--Create the grid list element
	local playerList = DGS:dgsCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
	--Create a players column in the list
	local column = DGS:dgsGridListAddColumn( playerList, "Player", 0.85 )
	if ( column ) then --If the column has been created, fill it with players
		for id, player in ipairs(getElementsByType("player")) do
			local row = DGS:dgsGridListAddRow ( playerList )
			DGS:dgsGridListSetItemText ( playerList, row, column, getPlayerName ( player ) )
		end
	end
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