/
getListBoxSelItems
getListBoxSelItems
Description
Gets the user list box selected items.
Returns an array of zero based indices of the selected items of the list box user control that is specified by userControlID
.
Because list box user controls can have multiple selected items (if the -multi flag was specified for the createListBox command), an array must be returned.
If there are no selected items, an empty array is returned.
Functional area
User Window
Command syntax
Syntax
getListBoxSelItems userControlID |
Arguments
Name | Type | Required | Comments |
---|---|---|---|
userControlId | int | yes | ID of user control to operate on. |
Flags
None
Return value
integer array
Examples
// Get the selected List Box User Control items int $windowId; int $controlId; int $indices[]; // First create a User Window to place the Control on $windowId = `createWindow "MyWindow"`; // Create the User Control on the Window. $controlId = `createListBox $windowId -multi`; // Add some items to the List Box. addListBoxItem $controlId "Item 1"; addListBoxItem $controlId "Item 2"; addListBoxItem $controlId "Item 3"; // Select the second and third items selectListBoxItem $controlId 1; selectListBoxItem $controlId 2; // Get the selected items $indices = `getListBoxSelItems $controlId`; print $indices;
Additional information
Related commands
- addListBoxItem
- createListBox
- deleteAllListBoxItems
- deleteListBoxItem
- findListBoxItem
- getListBoxItem
- getNumListBoxItems
- selectListBoxItem
- setListBoxHandler
, multiple selections available,
Related content
getListBoxItem
getListBoxItem
More like this
deleteAllListBoxItems
deleteAllListBoxItems
More like this
addListBoxItem
addListBoxItem
More like this
setListBoxHandler
setListBoxHandler
More like this
getListViewSelItems
getListViewSelItems
More like this
findListBoxItem
findListBoxItem
More like this