lbSetCurSel: Difference between revisions

Latest revision as of 01:29, 4 November 2025

1.75

1.00

1.50

1.00

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. For the ComboBox you might as well want to explicitly select index 0 to avoid showing ghost row.
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.

@@ Line 1: / Line 1: @@
-[[Category:Scripting Commands|L]]
+{{RV|type=command
-[[Category:Scripting Commands OFP 1.97|L]]
-[[Category:Scripting Commands ArmA|L]]
-back to [[Scripting_Reference#L|COMREF]]
+|game1= ofp
+|version1= 1.75
-<h2 style="color:#000066"> '''lbSetCurSel [''idc'', ''index'']'''</h2>
+|game2= ofpe
+|version2= 1.00
+|game3= arma1
+|version3= 1.00
-'''Operand types:'''
+|game4= arma2
+|version4= 1.00
-'''[idc, index]:''' [[Array]]
+|game5= arma2oa
+|version5= 1.50
-'''Type of returned value:'''
+|game6= tkoh
+|version6= 1.00
-[[Nothing]]
+|game7= arma3
+|version7= 0.50
-'''Compatibility:'''
+|gr1= GUI Control - ListBox
-Added in version '''1.50'''
+|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}}. For the ComboBox you might as well want to explicitly select index 0 to avoid showing ghost row.
+}}
-'''Description:'''
+|s1= [[lbSetCurSel]] [idc, index]
-Select item with given '''index''' of listbox or combobox with id '''idc''' of topmost user [[dialog]].
+|p1= idc: [[Number]] - control's IDC
+|p2= index: [[Number]]
-'''Example:'''
+|r1= [[Nothing]]
-'''lbSetCurSel''' [101, 0]
+|s2= control [[lbSetCurSel]] index
+|p21= control: [[Control]]
+|p22= index: [[Number]]
+|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.
+}}