Command Reference : Programming Language Reference
  
 
@uimlist
Syntax: @uimlist(IO_Selectitem, prompt_string, listbox_items)
Argument 1: vector IO_Select_item
Argument 2: string, prompt_string
Argument 3: string, listbox_items
Return: integer
Displays a dialog with a multiple-select listbox and prompt string. Fill the listbox by specifying listbox_items, a space delimited list of items. prompt_string specifies the text to be used as a label for the listbox. Initialize the listbox selection with workfile vector object IO_Selectitem, which will return the selection values on exit of the dialog.
Both prompt_string and listbox_items may be specified using in-line text, but IO_Selectitem must be either a program variable or an object in your workfile as it is used to return results.
The dialog shows an OK and Cancel button, and will return an integer representing the button clicked: Cancel (-1), OK (0).
Examples
vector(2) selected
selected.fill 1,3
@uimlist(selected, "Please select an item:", "Item1 Item2 Item3")
These commands display a dialog with a multiple listbox containing the items “Item1”, “Item2”, and “Item3”. The title “Please select an item:” appears above the listbox, and the first and third items are initially selected. If the user additionally selects the second item and presses OK, the vector SELECTED will contain the elements 1,2,3, and the dialog will return the value 0.
Cross-references
See “User-Defined Dialogs” for discussion.
See also @uilist, @uidialog, @uiedit, @uiprompt, @uiradio.