lbSetSelected: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "since= Arma3" to "since= arma3")
 
(90 intermediate revisions by 19 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|LBSETSELECTED]]
{{RV|type=command
[[Category:Scripting Commands ArmA|LBSETSELECTED]]


|game1= arma1
|version1= 1.00


<h2 style="color:#000066"> '''''control'' lbSetSelected ''[index, selected]'''''</h2>
|game2= arma2
|version2= 1.00


|game3= arma2oa
|version3= 1.50


'''Operand types:'''
|game4= tkoh
|version4= 1.00


'''control:''' [[Control]]
|game5= arma3
|version5= 0.50


'''[index, selected]:''' [[Array]]
|gr1= GUI Control - ListBox


'''Type of returned value:'''
|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.


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


'''Compatibility:'''
|p1= control: [[Control]]


Version 2.91 required.
|p2= index: [[Number]] or since {{GVI|arma3|2.12}} [[Array]] of [[Number]]s


'''Description:'''
|p3= selected: [[Boolean]]
|p4= forceEH: [[Boolean]] - (Optional, default [[false]]) will force [[User_Interface_Event_Handlers#onLBSelChanged | lbSelChanged]] EH to fire
|p4since= arma3 2.12


Set the selection state of the given row of the given listbox.
|r1= [[Nothing]]


Listbox must support multiple selection.
|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]]
'''Example'''
}}
 
_control '''lbSetSelected''' [0, true]

Latest revision as of 16:26, 9 February 2024

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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
Retrieved from "https://community.bistudio.com/wiki?title=lbSetSelected&oldid=352415"