lbSetSelected: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \{\{GameCategory *\| *arma1 *\| *(New )?Scripting Commands\}\}" to "")
m (Text replacement - "since= Arma3" to "since= arma3")
 
(27 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma1
|game1= arma1
|version1= 1.00


|1.00|=Game version
|game2= arma2
|version2= 1.00
 
|game3= arma2oa
|version3= 1.50
 
|game4= tkoh
|version4= 1.00
 
|game5= arma3
|version5= 0.50


|gr1= GUI Control - ListBox
|gr1= GUI Control - ListBox


| Sets the selection state of the given row of the given listbox of style LB_MULTI. The command has to be called for every row which is needed to be selected in multi-selection listbox. For single selection listbox use [[lbSetCurSel]] instead.
|descr= Sets the selection state of the given row of the given listbox of style LB_MULTI.
The command has to be called for every row which is needed to be selected in multi-selection listbox. Use negative index -1 to select/deselect all rows (since {{GVI|arma3|2.12}}).
For single selection listbox use [[lbSetCurSel]] instead.


|s1= control '''lbSetSelected''' [index, selected]
|s1= control [[lbSetSelected]] [index, selected, forceEH]


|p1= control: [[Control]]
|p1= control: [[Control]]
|p2= [index, selected]: [[Array]]
|p3= index: [[Number]]
|p4= selected: [[Boolean]]


|r1=[[Nothing]]
|p2= index: [[Number]] or since {{GVI|arma3|2.12}} [[Array]] of [[Number]]s
 
|p3= selected: [[Boolean]]
|p4= forceEH: [[Boolean]] - (Optional, default [[false]]) will force [[User_Interface_Event_Handlers#onLBSelChanged | lbSelChanged]] EH to fire
|p4since= arma3 2.12


|x1= <code>_control [[lbSetSelected]] [0, [[true]]<nowiki>]</nowiki>;</code>
|r1= [[Nothing]]


|seealso= [[lbAdd]], [[lbClear]], [[lbColor]], [[lbCurSel]], [[lbData]], [[lbDelete]], [[lbIsSelected]], [[lbPicture]], [[lbSelection]], [[lbSetColor]], [[lbSetCurSel]], [[lbSetData]], [[lbSetPicture]], [[lbSetTooltip]], [[lbSetValue]], [[lbSize]], [[lbSort]], [[lbSortByValue]], [[lbText]], [[lbValue]]
|x1= <sqf>_control lbSetSelected [0, true];</sqf>
 
|seealso= [[lbAdd]] [[lbClear]] [[lbColor]] [[lbCurSel]] [[lbData]] [[lbDelete]] [[lbIsSelected]] [[lbPicture]] [[lbSelection]] [[lbSetColor]] [[lbSetCurSel]] [[lbSetData]] [[lbSetPicture]] [[lbSetTooltip]] [[lbSetValue]] [[lbSize]] [[lbSort]] [[lbSortByValue]] [[lbText]] [[lbValue]]
}}
}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 17:26, 9 February 2024

Hover & click on the images for description

Description

Description:
Sets the selection state of the given row of the given listbox of style LB_MULTI. The command has to be called for every row which is needed to be selected in multi-selection listbox. Use negative index -1 to select/deselect all rows (since Arma 3 logo black.png2.12). For single selection listbox use lbSetCurSel instead.
Groups:
GUI Control - ListBox

Syntax

Syntax:
control lbSetSelected [index, selected, forceEH]
Parameters:
control: Control
index: Number or since Arma 3 logo black.png2.12 Array of Numbers
selected: Boolean
since Arma 3 logo black.png2.12
forceEH: Boolean - (Optional, default false) will force lbSelChanged EH to fire
Return Value:
Nothing

Examples

Example 1:
_control lbSetSelected [0, true];

Additional Information

See also:
lbAdd lbClear lbColor lbCurSel lbData lbDelete lbIsSelected lbPicture lbSelection lbSetColor lbSetCurSel lbSetData lbSetPicture lbSetTooltip lbSetValue lbSize lbSort lbSortByValue lbText lbValue

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note