DgsGridListGetSelectedCount - Revision history

Thisdp: /* Syntax */

2021-01-17T08:33:53Z

Syntax

← Older revision		Revision as of 08:33, 17 January 2021
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	int ~~guiGridListGetSelectedCount~~ ( element gridList [, int inRow = -1, int inColumn = -1 ] )		int dgsGridListGetSelectedCount ( element gridList [, int inRow = -1, int inColumn = -1 ] )
	</syntaxhighlight>		</syntaxhighlight>

Thisdp at 07:37, 11 July 2019

2019-07-11T07:37:53Z

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

Thisdp: /* Example */

2019-07-11T06:07:52Z

Example

← Older revision		Revision as of 06:07, 11 July 2019
Line 25:		Line 25:
	DGS:dgsGridListAddColumn(gridlist,"Players",0.50)		DGS:dgsGridListAddColumn(gridlist,"Players",0.50)
	for i,v in ipairs(getElementsByType("player"))do		for i,v in ipairs(getElementsByType("player"))do
	~~DGS:dgsGridListSetItemText(gridlist,~~DGS:dgsGridListAddRow(gridlist),1,getPlayerName(v)~~,false,false~~)		DGS:dgsGridListAddRow(gridlist,_,getPlayerName(v))
	end		end
	for b=0, DGS:dgsGridListGetRowCount(gridlist)do		for b=0, DGS:dgsGridListGetRowCount(gridlist)do

Thisdp: /* =Optional Arguments */

2019-07-11T06:06:05Z

=Optional Arguments

← Older revision		Revision as of 06:06, 11 July 2019
Line 11:		Line 11:
	*'''gridList:''' The dgs grid list whose amount of selected items you want to retrieve.		*'''gridList:''' The dgs grid list whose amount of selected items you want to retrieve.

	===Optional Arguments==		===Optional Arguments===
	*''' inRow:''' An integer of the index of the specific row ( used to get the count of items from the specific row ).		*''' inRow:''' An integer of the index of the specific row ( used to get the count of items from the specific row ).
	*''' inColumn:''' An integer of the index of the specific column ( used to get the count of items from the specific column ).		*''' inColumn:''' An integer of the index of the specific column ( used to get the count of items from the specific column ).

Thisdp: /* Example */

2019-07-11T06:05:57Z

Example

← Older revision		Revision as of 06:05, 11 July 2019
Line 32:		Line 32:
	end		end
	end		end
	outputChatBox("The number of Players with 'a' in their name: "..~~guiGridListGetSelectedCount~~(gridlist)..".")		outputChatBox("The number of Players with 'a' in their name: "..DGS:dgsGridListGetSelectedCount(gridlist)..".")
	</syntaxhighlight>		</syntaxhighlight>

Thisdp at 06:05, 11 July 2019

2019-07-11T06:05:50Z

← Older revision		Revision as of 06:05, 11 July 2019
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	This function returns the ~~items~~ selected in the specified dgs grid list.		This function returns the amount of options selected in the specified dgs grid list.

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

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~table dgsGridListGetSelectedItems~~ ( element gridList )		int guiGridListGetSelectedCount ( element gridList [, int inRow = -1, int inColumn = -1 ] )
	</syntaxhighlight>		</syntaxhighlight>

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

			===Optional Arguments==
			*''' inRow:''' An integer of the index of the specific row ( used to get the count of items from the specific row ).
			*''' inColumn:''' An integer of the index of the specific column ( used to get the count of items from the specific column ).

	===Returns===		===Returns===
	Returns ~~a table over~~ the selected ~~items in the dgs grid list in this format ( the same as cegui's ) :~~		Returns an integer representing the amount of selected options if everything was successful or ''false'' if invalid arguments were passed.
	~~<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==		==Example==
			This example creates a gridlist filled with players names then check who has the letter "a" in their name, after it selects everyone who has the letter "a" then it outputs the selected rows.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	DGS = exports.dgs		DGS = exports.dgs
	~~-- This example creates a grid list of all players, clicking "Selected" button will then use dgsGridListGetSelectedItems to show all selected items.~~		gridlist = DGS:dgsCreateGridList(100,100,200,100,false)
	~~playerWindow = DGS:dgsCreateWindow(526, 230, 291, 284, "", false)~~		DGS:dgsGridListAddColumn(gridlist,"Players",0.50)
	~~gridlistPlayers~~ = DGS:dgsCreateGridList(9, 23, ~~272~~, ~~201~~, false~~, playerWindow~~)		for i,v in ipairs(getElementsByType("player"))do
	DGS:dgsGridListAddColumn(~~gridlistPlayers~~, "Players", 0.9)		DGS:dgsGridListSetItemText(gridlist,DGS:dgsGridListAddRow(gridlist),1,getPlayerName(v),false,false)
	~~DGS:dgsGridListSetSelectionMode(gridlistPlayers, 1~~) ~~-- So can select many players~~		end
	for _, ~~players~~ in ipairs(getElementsByType("player")) do		for b=0, DGS:dgsGridListGetRowCount(gridlist)do
	~~local row =~~ DGS:~~dgsGridListAddRow~~(~~gridlistPlayers)~~		if(string.find(DGS:dgsGridListGetItemText(gridlist,b,1),"a",1,true))then
	DGS:~~dgsGridListSetItemText~~(~~gridlistPlayers, row~~, 1, getPlayerName(~~players~~))		DGS:dgsGridListSetSelectedItem(gridlist,b,1)
	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
	end		end
	~~addEventHandler~~("~~onDgsMouseClick~~"~~, buttonSelectedPlayer, seeSelected, false~~)		outputChatBox("The number of Players with 'a' in their name: "..guiGridListGetSelectedCount(gridlist)..".")
	</syntaxhighlight>		</syntaxhighlight>

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-11T05:59:29Z

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 [[guiGridListGetSelectedCount]].

==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}}

DgsGridListGetSelectedCount - Revision history

Thisdp: /* Syntax */

Thisdp at 07:37, 11 July 2019

Thisdp: /* Example */

Thisdp: /* =Optional Arguments */

Thisdp: /* Example */

Thisdp at 06:05, 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..."