lbSetSelected: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "since= Arma3" to "since= arma3")
 
(68 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= arma1
|version1= 1.00


|1.00|=Game version
|game2= arma2
____________________________________________________________________________________________
|version2= 1.00


| Set the selection state of the given row of the given listbox.
|game3= arma2oa
|version3= 1.50


Listbox must support multiple selection. |= Description
|game4= tkoh
____________________________________________________________________________________________
|version4= 1.00


| control '''lbSetSelected''' [index, selected] |= Syntax
|game5= arma3
|p1= control: [[Control]] |= Parameter 1
|version5= 0.50
|p2= [index, selected]: [[Array]] |= Parameter 2
|p3= index: [[Number]] |= Parameter 3
|p4= selected: [[Boolean]] |= Parameter 4


| [[Nothing]] |= Return value
|gr1= GUI Control - ListBox
____________________________________________________________________________________________
 
|x1= <pre>_control lbSetSelected [0, true]</pre> |= Example 1
____________________________________________________________________________________________


| [[lbSelection]] |= See also
|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, forceEH]


<h3 style="display:none">Notes</h3>
|p1= control: [[Control]]
<dl class="command_description">
<!-- Note Section BEGIN -->
----


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


--[[User:JacmacBrian|JacmacBrian]] ([[User talk:JacmacBrian|talk]]) 02:41, 29 March 2014 (CET)
|p3= selected: [[Boolean]]
|p4= forceEH: [[Boolean]] - (Optional, default [[false]]) will force [[User_Interface_Event_Handlers#onLBSelChanged | lbSelChanged]] EH to fire
|p4since= arma3 2.12


As of at least the timestamp of this note, this command is broken in Arma 3. As a work-around use:
|r1= [[Nothing]]
<pre>lbSetCurSel [_controlnum, _item]; //where _controlnum = the IDC, and _item is the index of the item you want selected</pre>


<!-- Note Section END -->
|x1= <sqf>_control lbSetSelected [0, true];</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[lbAdd]] [[lbClear]] [[lbColor]] [[lbCurSel]] [[lbData]] [[lbDelete]] [[lbIsSelected]] [[lbPicture]] [[lbSelection]] [[lbSetColor]] [[lbSetCurSel]] [[lbSetData]] [[lbSetPicture]] [[lbSetTooltip]] [[lbSetValue]] [[lbSize]] [[lbSort]] [[lbSortByValue]] [[lbText]] [[lbValue]]
[[Category:Scripting Commands|LBSETSELECTED]]
}}
[[Category:Scripting Commands ArmA|LBSETSELECTED]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]

Latest revision as of 17: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"