lbSetSelected: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "since= Arma3" to "since= arma3")
 
(62 intermediate revisions by 4 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


____________________________________________________________________________________________
|game3= arma2oa
|version3= 1.50


| Set the selection state of the given row of the given listbox of style LB_MULTI. For single selection listbox use [[lbSetCurSel]] instead.|DESCRIPTION=
|game4= tkoh
____________________________________________________________________________________________
|version4= 1.00


| control '''lbSetSelected''' [index, selected] |SYNTAX=
|game5= arma3
|p1= control: [[Control]] |PARAMETER1=
|version5= 0.50
|p2= [index, selected]: [[Array]] |PARAMETER2=
|p3= index: [[Number]] |PARAMETER3=
|p4= selected: [[Boolean]] |PARAMETER4=


| [[Nothing]] |RETURNVALUE=
|gr1= GUI Control - ListBox
____________________________________________________________________________________________
 
|x1= <code>_control [[lbSetSelected]] [0, [[true]]<nowiki>]</nowiki>;</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[lbAdd]], [[lbClear]], [[lbColor]], [[lbCurSel]], [[lbData]], [[lbDelete]], [[lbIsSelected]], [[lbPicture]], [[lbSelection]], [[lbSetColor]], [[lbSetCurSel]], [[lbSetData]], [[lbSetPicture]], [[lbSetTooltip]], [[lbSetValue]], [[lbSize]], [[lbSort]], [[lbSortByValue]], [[lbText]], [[lbValue]] |SEEALSO=
|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]
 
|p1= control: [[Control]]
 
|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


<h3 style="display:none">Notes</h3>
|r1= [[Nothing]]
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
|x1= <sqf>_control lbSetSelected [0, true];</sqf>
[[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}}}}]]


<!-- CONTINUE Notes -->
|seealso= [[lbAdd]] [[lbClear]] [[lbColor]] [[lbCurSel]] [[lbData]] [[lbDelete]] [[lbIsSelected]] [[lbPicture]] [[lbSelection]] [[lbSetColor]] [[lbSetCurSel]] [[lbSetData]] [[lbSetPicture]] [[lbSetTooltip]] [[lbSetValue]] [[lbSize]] [[lbSort]] [[lbSortByValue]] [[lbText]] [[lbValue]]
<dl class="command_description">
}}
<dd class="notedate">Posted on April 10, 2016 - 16:48 (UTC)</dd>
<dt class="note">[[User:Larrow|Larrow]]</dt>
<dd class="note">
This command works fine with listboxs of style LB_MULTI and should not be marked as obsolete as lbSetCurSel does not provide the same functionality.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

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"