Thisdp at 07:37, 11 July 2019

2019-07-11T07:37:57Z

← Older revision		Revision as of 07:37, 11 July 2019
Line 57:		Line 57:
	==See Also==		==See Also==
	{{DGSFUNCTIONS}}		{{DGSFUNCTIONS}}
	~~{{DGSEVENTS}}~~

Thisdp: Created page with "{{Client function}} NOTOC This function returns the items selected in the specified dgs grid list. Note that the index of row and column start from 1, which is different..."

2019-07-11T06:00:02Z

Created page with "{{Client function}} __NOTOC__ This function returns the items selected in the specified dgs grid list. Note that the index of row and column start from 1, which is different..."

New page

{{Client function}}
__NOTOC__
This function returns the items selected in the specified dgs grid list.

Note that the index of row and column start from 1, which is different from [[guiGridListGetSelectedItems]].

==Syntax==
<syntaxhighlight lang="lua">
table dgsGridListGetSelectedItems ( element gridList )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' The dgs grid list which selected items you want to retrieve.

===Returns===
Returns a table over the selected items in the dgs grid list in this format ( the same as cegui's ) :
<syntaxhighlight lang="lua">
table = {
[1] = {
["column"], -- has the first selected item's column ID
["row"] -- has the first selected item's row ID
},
[2] = {
["column"],-- has the second selected item's column ID
["row"] -- has the second selected item's row ID
},
...
}

</syntaxhighlight>
if everything was successful or ''false'' if invalid arguments were passed.

==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs
-- This example creates a grid list of all players, clicking "Selected" button will then use dgsGridListGetSelectedItems to show all selected items.
playerWindow = DGS:dgsCreateWindow(526, 230, 291, 284, "", false)
gridlistPlayers = DGS:dgsCreateGridList(9, 23, 272, 201, false, playerWindow)
DGS:dgsGridListAddColumn(gridlistPlayers, "Players", 0.9)
DGS:dgsGridListSetSelectionMode(gridlistPlayers, 1) -- So can select many players
for _, players in ipairs(getElementsByType("player")) do
local row = DGS:dgsGridListAddRow(gridlistPlayers)
DGS:dgsGridListSetItemText(gridlistPlayers, row, 1, getPlayerName(players))
end
buttonSelectedPlayer = DGS:dgsCreateButton(9, 227, 272, 20, "Selected", false, playerWindow)

function seeSelected()
local selected = DGS:dgsGridListGetSelectedItems(gridlistPlayers)
for i, data in ipairs(selected) do -- Loops through all selected items
outputChatBox(DGS:dgsGridListGetItemText(gridlistPlayers, data["row"], 1)) -- Shows player name of selected players
end
end
addEventHandler("onDgsMouseClick", buttonSelectedPlayer, seeSelected, false)
</syntaxhighlight>

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

DgsGridListGetSelectedItems - Revision history

Thisdp at 07:37, 11 July 2019

Thisdp: Created page with "{{Client function}} __NOTOC__ This function returns the items selected in the specified dgs grid list. Note that the index of row and column start from 1, which is different..."

Thisdp: Created page with "{{Client function}} NOTOC This function returns the items selected in the specified dgs grid list. Note that the index of row and column start from 1, which is different..."