GetItem GetNumber

GetItemStr


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

getitemdlg.jpg

List box shown opened with 4 choices.

Syntax

sItem, bOK = GetItemStr( sLabels, n=nil, sPrompt=nil, sTitle=nil )

Remarks

All arguments following sLabels are optional and assume default values beyond 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 choice is returned as a string in sItem. 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:

 

str, bOK = GetItemStr(

 

            "First choice...\n" ..

            "Second choice...\n" ..

            "Third choice...\n" ..

            "The last choice !",

-- the labels (concatenated)

            2)

-- initial choice

Related Topics

GetItem, GetChoice