lbSetCurSel: Difference between revisions

Revision as of 01:26, 20 January 2021

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 applicable to 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 unselecting entries, instead it will select the first one. If you really need to unselect a combobox then follow these steps:

Are you really really sure you want to unselect a combobox? This behavior is inconsistent with the usual functionality of a combobox.
Read the note from DreadedEntity below.

Groups:

GUI Control - ListBox

Syntax

Syntax:: lbSetCurSel [idc, index]
Parameters:: [idc, index]: Array
: idc: Number of control
: 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:: lbAdd lbClear lbColor lbCurSel lbData lbDelete lbIsSelected lbPicture lbSelection lbSetColor lbSetData lbSetPicture lbSetSelected 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

Posted on November 29, 2014 - 23:40 (UTC)
DreadedEntity: 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.; Posted on March 1, 2015 - 18:37 (UTC)
Longbow: Keep in mind that running this command against control will fire attached 'onLBSelChanged' event handler.

@@ Line 10: / Line 10: @@
 {{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.<br>[[CT_COMBO]] does not allow unselecting entries, instead it will select the first one. If you really need to unselect a combobox then follow these steps:<br>
 # Are you really really sure you want to unselect a combobox? This behavior is inconsistent with the usual functionality of a combobox.
-# Read the note from [[User:DreadedEntity|DreadedEntity]] below.}}
+# Read the note from [[#Notes|DreadedEntity]] below.}}
 | '''lbSetCurSel''' [idc, index]
@@ Line 30: / Line 30: @@
 | [[lbAdd]], [[lbClear]], [[lbColor]], [[lbCurSel]], [[lbData]], [[lbDelete]], [[lbIsSelected]], [[lbPicture]], [[lbSelection]], [[lbSetColor]], [[lbSetData]], [[lbSetPicture]], [[lbSetSelected]], [[lbSetTooltip]], [[lbSetValue]], [[lbSize]], [[lbSort]], [[lbSortByValue]], [[lbText]], [[lbValue]]
 }}
-<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>
 [[Category:Scripting Commands|LBSETCURSEL]]