SelectedIndex
PowerScript function
Description
Obtains the number of the selected item in a ListBox, ListView, or
RibbonComboBoxItem control.
Applies to
ListBox, ListView, and RibbonComboBoxItem controls
Syntax
|
1 |
listcontrolname.SelectedIndex ( ) |
|
Argument |
Description |
|---|---|
|
listcontrolname |
The name of the ListBox, ListView, or RibbonComboBoxItem |
Return value
Integer.
Returns the index of the selected item in listcontrolname. If more
than one item is selected, SelectedIndex returns the index of the first
selected item. If there are no selected items or an error occurs,
SelectedIndex returns -1. If listcontrolname is null, SelectedIndex
returns null.
Usage
SelectedIndex and SelectedItem are meant for lists that allow a
single selection only (when the MultiSelect property for the control is
false).
When the MultiSelect property is true, SelectedIndex gets the index
of the first selected item only. Use the State function, instead of
SelectedIndex, to check each item in the list and find out if it is
selected. Use the Text function to get the text of any item in the
list.
Examples
If item 5 in lb_actions is selected, then this example sets li_Index
to 5:
|
1 2 |
integer li_Index li_Index = lb_actions.SelectedIndex() |
These statements open the window w_emp if item 5 in lb_actions is
selected:
|
1 2 3 |
integer li_X li_X = lb_actions.SelectedIndex() If li_X = 5 then Open(w_emp) |
These statements return the index of the selected item in the
RibbonBar ComboBox:
|
1 2 3 4 5 6 |
Integer li_Return RibbonComboBoxItem lr_ComboBox li_Return = lr_ComboBox.AddItem("Item1") li_Return = lr_ComboBox.AddItem("Item2") li_Return = lr_ComboBox.SelectedIndex() |
See also