GetItem

The GetItem function opens a dialog showing a list of items in a list box. This function returns the index of the selected item and the button that was clicked. All labels can be configured. This is similar to the GetItemStr function except that it returns the index of the selected string and not the string itself.

Syntax

nIndex, bOK = GetItem( sLabels, n=nil, sPrompt=nil, sTitle=nil )

    sLabels is a string containing the list of item labels, separated by \n.

    n is the index of the initial choice, beginning with 1. If nil, item 1 is chosen.

    sPrompt is the message above the list box. If nil, a default is used.

    sTitle is the window title. If nil, a default is used.

    If [OK] is clicked, the function returns the selected string and bOK=true.

    If the dialog is canceled, "",false is returned.

Remarks

All arguments following sLabels are optional and assume default values after the last argument you specify. To use a default argument but follow it with a specified argument, use a nil in its place.

The items are specified as a single string using \n to separate the individual items. For example, to specify the labels as "First item" and "Second item", pass the sLabels argument as "First item\nSecond item".

The index of the choice is returned as nIndex, beginning at 1. If the User clicks [OK], then bOK=true. Otherwise, if the user clicks [Cancel], then bOK=false.

Example

The window shown above was created using the following code. Note that the last 2 arguments, the prompt and the window title, were omitted and left to the defaults:

Related Topics

GetItemStr, GetChoice