lbSetCurSel: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <!-- (DIS)?CONTINUE Notes -->" to "")
m (Some wiki formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofp
|game1= ofp
|version1= 1.75


|
|game2= ofpe
|version2= 1.00
 
|game3= arma1
|version3= 1.00
 
|game4= arma2
|version4= 1.00
 
|game5= arma2oa
|version5= 1.51
 
|game6= tkoh
|version6= 1.00
 
|game7= arma3
|version7= 0.50


|gr1= GUI Control - ListBox
|gr1= GUI Control - ListBox


| 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 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>
{{Feature | important | '''The following only applies to the [[#Syntax_2|Alternative Syntax]] when used with [[CT_LISTBOX]] and [[CT_LISTNBOX]].'''<br>
# Are you really really sure you want to unselect a combobox? This behavior is inconsistent with the usual functionality of a combobox.
To deselect all entries, use -1: <tt>_ctrl [[lbSetCurSel]] -1;</tt> For listbox of style LB_MULTI use [[lbSetSelected]] instead.<br>
# Read the note from [[#Notes|DreadedEntity]] below.}}
[[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]].
}}
 
|s1= [[lbSetCurSel]] [idc, index]
 
|p1= idc: [[Number]] - control's IDC
 
|p2= index: [[Number]]


| '''lbSetCurSel''' [idc, index]
|r1= [[Nothing]]
|p1= [idc, index]: [[Array]]
|p2= idc: [[Number]] of control
|p3= index: [[Number]]
| [[Nothing]]


|s2= control '''lbSetCurSel''' index
|s2= control [[lbSetCurSel]]  index


|p21= control: [[Control]]
|p21= control: [[Control]]
|p22= index: [[Number]]
|p22= index: [[Number]]
|r2= [[Nothing]]
|r2= [[Nothing]]
   
   
Line 28: Line 51:
|x2= <code>_control [[lbSetCurSel]] 0;</code>
|x2= <code>_control [[lbSetCurSel]] 0;</code>


|seealso= [[lbAdd]], [[lbClear]], [[lbColor]], [[lbCurSel]], [[lbData]], [[lbDelete]], [[lbIsSelected]], [[lbPicture]], [[lbSelection]], [[lbSetColor]], [[lbSetData]], [[lbSetPicture]], [[lbSetSelected]], [[lbSetTooltip]], [[lbSetValue]], [[lbSize]], [[lbSort]], [[lbSortByValue]], [[lbText]], [[lbValue]]
|seealso= [[lbCurSel]]
}}
}}
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}


<dl class="command_description">
<dl class="command_description">
Line 44: Line 61:
'''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.
'''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>
</dd>
<dt><dt>
<dt><dt>
<dd class="notedate">Posted on March 1, 2015 - 18:37 (UTC)</dd>
<dd class="notedate">Posted on March 1, 2015 - 18:37 (UTC)</dd>
<dt class="note">[[User:Longbow|Longbow]]</dt>
<dt class="note">[[User:Longbow|Longbow]]</dt>
<dd class="note">
<dd class="note">
Keep in mind that running this command against control will fire attached 'onLBSelChanged' event handler.
Keep in mind that running this command will fire the 'onLBSelChanged' event handler.
</dd>
</dd>
</dl>
</dl>

Revision as of 22:20, 12 April 2021

Logo A0.png1.75ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.51tkoh logo small.png1.00Arma 3 logo black.png0.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
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.
Retrieved from "https://community.bistudio.com/wiki?title=lbSetCurSel&oldid=255317"