lbSetCurSel: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| ofp |Game name=
| ofp


|1.5|Game version=
|1.5


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


| Selects the item with the given index in the listbox, listnbox, combobox, xcombobox, xlistbox<br>
| Selects the item with the given index in the listbox, listnbox, combobox, xcombobox, xlistbox<br>
{{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>
{{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.
# 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.}}|DESCRIPTION=
# Read the note from [[User:DreadedEntity|DreadedEntity]] below.}}


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


|s2= control '''lbSetCurSel''' index |SYNTAX2=
|s2= control '''lbSetCurSel''' index


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


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


}}
}}

Revision as of 01:06, 18 January 2021

Logo A0.png1.5
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:
  1. Are you really really sure you want to unselect a combobox? This behavior is inconsistent with the usual functionality of a combobox.
  2. 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:
lbAddlbClearlbColorlbCurSellbDatalbDeletelbIsSelectedlbPicturelbSelectionlbSetColorlbSetDatalbSetPicturelbSetSelectedlbSetTooltiplbSetValuelbSizelbSortlbSortByValuelbTextlbValue

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

Notes

Posted: Sep 10 2014
ffur2007slx2_5
More information on the LB command family can be found here

Bottom Section

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.
Retrieved from "https://community.bistudio.com/wiki?title=lbSetCurSel&oldid=206110"