lbSetCurSel: Difference between revisions

From Bohemia Interactive Community
m (Text replacement - " [https://community.bistudio.com/wiki/List_Box here]" to " here")
m (Some wiki formatting)
 
(40 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| ofp |Game name=
|game1= ofp
|version1= 1.75


|1.5|Game version=
|game2= ofpe
|version2= 1.00


____________________________________________________________________________________________
|game3= arma1
|version3= 1.00


| Selects the item with the given index in the listbox, listnbox, combobox, xcombobox, xlistbox<br>
|game4= arma2
{{Important | '''The following only applicable to Alternative Syntax when used with [[CT_LISTBOX]] and [[CT_LISTNBOX]]'''<br>To deselect all entries, use -1: <tt>_ctrl [[lbSetCurSel]] -1;</tt> For listbox of style LB_MULTI use [[lbSetSelected]] instead.}}|DESCRIPTION=
|version4= 1.00
____________________________________________________________________________________________


| '''lbSetCurSel''' [idc, index] |SYNTAX=
|game5= arma2oa
|p1= [idc, index]: [[Array]] |PARAMETER1=
|version5= 1.50
|p2= idc: [[Number]] of control |PARAMETER2=
|p3= index: [[Number]] |PARAMETER3=
| [[Nothing]] |RETURNVALUE=


|s2= control '''lbSetCurSel''' index |SYNTAX2=
|game6= tkoh
|version6= 1.00


|p21= control: [[Control]] |PARAMETER21=
|game7= arma3
|p22= index: [[Number]] |PARAMETER2=
|version7= 0.50
|r2= [[Nothing]] |RETURNVALUE2=
____________________________________________________________________________________________
 
|x1= <code>[[lbSetCurSel]] [101, 0];</code> |EXAMPLE1=
 
|x2= <code>_control [[lbSetCurSel]] 0;</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[lbAdd]], [[lbClear]], [[lbColor]], [[lbCurSel]], [[lbData]], [[lbDelete]], [[lbIsSelected]], [[lbPicture]], [[lbSelection]], [[lbSetColor]], [[lbSetData]], [[lbSetPicture]], [[lbSetSelected]], [[lbSetTooltip]], [[lbSetValue]], [[lbSize]], [[lbSort]], [[lbSortByValue]], [[lbText]], [[lbValue]] |SEEALSO=
|gr1= GUI Control - ListBox


|descr= Selects the item with the given index in the listbox, listnbox, combobox, xcombobox, xlistbox<br>
{{Feature|important|'''The following only applies to the {{Link|#Syntax 2|Alternative Syntax}} when used with [[CT_LISTBOX]] and [[CT_LISTNBOX]].'''<br>
To deselect all entries, use -1: <sqf inline>_ctrl lbSetCurSel -1;</sqf> For listbox of style LB_MULTI use [[lbSetSelected]] instead.<br>
[[CT_COMBO]] does not allow deselecting entries, it will instead select the first one as it is not a combobox usual behaviour.
If you really need to deselect a combobox, see {{Link|#Notes|DreadedEntity's note}}.
}}
}}


<h3 style="display:none">Notes</h3>
|s1= [[lbSetCurSel]] [idc, index]
<dl class="command_description">
<!-- Note Section BEGIN -->
<dd class="notedate">Posted: Sep 10 2014</dd>
<dt class="note">[[User:ffur2007slx2_5|ffur2007slx2_5]]</dt>
<dd class="note">More information on the LB command family can be found [[List Box|here]]
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
|p1= idc: [[Number]] - control's IDC
[[Category:Scripting Commands|LBSETCURSEL]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|LBSETCURSEL]]
[[Category:Scripting Commands ArmA|LBSETCURSEL]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
|p2= index: [[Number]]
<dl class="command_description">
<dd class="notedate">Posted on November 29, 2014 - 23:40 (UTC)</dd>
<dt class="note">[[User:DreadedEntity|DreadedEntity]]</dt>
<dd class="note">
'''Prior to ArmA 1.90''' lbSetCurSel -1 had no effect while the listbox was populated. You needed to use [[lbClear]] first, then lbSetCurSel -1, then re-populate the listbox.
</dd>
</dl>
<!-- DISCONTINUE Notes -->


<!-- CONTINUE Notes -->
|r1= [[Nothing]]
<dl class="command_description">
 
<dd class="notedate">Posted on March 1, 2015 - 18:37 (UTC)</dd>
|s2= control [[lbSetCurSel]] index
<dt class="note">[[User:Longbow|Longbow]]</dt>
 
<dd class="note">
|p21= control: [[Control]]
Keep in mind that running this command against control will fire attached 'onLBSelChanged' event handler.
 
</dd>
|p22= index: [[Number]]
</dl>
 
<!-- DISCONTINUE Notes -->
|r2= [[Nothing]]
 
|x1= <sqf>lbSetCurSel [101, 0];</sqf>
 
|x2= <sqf>_control lbSetCurSel 0;</sqf>
 
|seealso= [[lbCurSel]]
}}
 
{{Note
|user= DreadedEntity
|timestamp= 20141129234000
|text= '''Prior to ArmA 1.90''' lbSetCurSel -1 had no effect while the listbox was populated. You needed to use [[lbClear]] first, then lbSetCurSel -1, then re-populate the listbox.
}}
 
{{Note
|user= Longbow
|timestamp= 20150301183700
|text= Keep in mind that running this command will fire the 'onLBSelChanged' event handler.
}}

Latest revision as of 16:43, 27 July 2023

Logo A0.png 1.75ofpe logo.png 1.00Logo A1 black.png 1.00Logo A2.png 1.00A2 OA Logo.png 1.50tkoh logo small.png 1.00Arma 3 logo black.png 0.50
Hover & click on the images for description

Description

Description:
Selects the item with the given index in the listbox, listnbox, combobox, xcombobox, xlistbox
⚠
The following only applies to the Alternative Syntax when used with CT_LISTBOX and CT_LISTNBOX.

To deselect all entries, use -1: _ctrl lbSetCurSel -1; For listbox of style LB_MULTI use lbSetSelected instead.
CT_COMBO does not allow deselecting entries, it will instead select the first one as it is not a combobox usual behaviour.

If you really need to deselect a combobox, see DreadedEntity's note.
Groups:
GUI Control - ListBox

Syntax

Syntax:
lbSetCurSel [idc, index]
Parameters:
idc: Number - control's IDC
index: Number
Return Value:
Nothing

Alternative Syntax

Syntax:
control lbSetCurSel index
Parameters:
control: Control
index: Number
Return Value:
Nothing

Examples

Example 1:
lbSetCurSel [101, 0];
Example 2:
_control lbSetCurSel 0;

Additional Information

See also:
lbCurSel

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
DreadedEntity - c
Posted on Nov 29, 2014 - 23:40 (UTC)
Prior to ArmA 1.90 lbSetCurSel -1 had no effect while the listbox was populated. You needed to use lbClear first, then lbSetCurSel -1, then re-populate the listbox.
Longbow - c
Posted on Mar 01, 2015 - 18:37 (UTC)
Keep in mind that running this command will fire the 'onLBSelChanged' event handler.
Retrieved from "https://community.bistudio.com/wiki?title=lbSetCurSel&oldid=343863"