lbSetCurSel: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "</dd> </dl>" to "</dd> </dl>")
m (Text replacement - "<tt>([^= ]+)<\/tt>" to "{{hl|$1}}")
Line 26: Line 26:
|descr= Selects the item with the given index in the listbox, listnbox, combobox, xcombobox, xlistbox<br>
|descr= Selects the item with the given index in the listbox, listnbox, combobox, xcombobox, xlistbox<br>
{{Feature | important | '''The following only applies to the [[#Syntax_2|Alternative Syntax]] when used with [[CT_LISTBOX]] and [[CT_LISTNBOX]].'''<br>
{{Feature | important | '''The following only applies to the [[#Syntax_2|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>
To deselect all entries, use -1: {{hl|_ctrl [[lbSetCurSel]] -1;}} 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.
[[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 [[#Notes|DreadedEntity's note]].
If you really need to deselect a combobox, see [[#Notes|DreadedEntity's note]].

Revision as of 00:15, 16 November 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 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
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 will fire the 'onLBSelChanged' event handler.