List Box Object - Get Item Text

Returns the text of a specific item (or a delimited list of items) from a List Box Object.

Action ID:
Action Category:
Action List Syntax:

117
List Box Object
<<VARIABLE>>
= ListBoxObject[<<OBJECT>>].GetItemText (<<GETTYPE>>)

Settings

Name:

The name of the List Box Object that you want to examine.

Get

The type of retrieval you would like to perform on the List Box Object. Choose from:

Selected item(s)

-

Get the item (or items) currently selected in the List Box Object.

All items

-

Get all of the items in the List Box Object.

Specific items

-

Get the items listed by index in the Index field.

Index:

The zero-based index of the item you want to get from the List Box Object. To specify multiple items, use a delimited list of indexes.

This field is only available when Specific items is selected above.

Delimiter:

The delimiter that you used to separate items in the Index field. If the text in the Index field is not a delimited list, you can leave this field blank.

Variable

Store result in variable:

The name of the variable that the item (or items) will be stored in.

Delimiter:

The delimiter that will be used to separate items if more then one item is returned from the List Box Object.

Error Codes

Value
(%LastErrorNum%)

Simple Message
(%LastErrorMsg%)

Verbose Message
(%LastErrorDetails%)

0 (OK)

 

 

1

MSG_ERR_LIST_BOX_OBJECT_GET_ITEM_TEXT

MSG_ERR_LIST_BOX_OBJECT_GET_ITEM_TEXT
MSG_ERR_OBJECT_NOT_FOUND
<<LISTNAME>>

1

MSG_ERR_LIST_BOX_OBJECT_GET_ITEM_TEXT

MSG_ERR_LIST_BOX_OBJECT_GET_ITEM_TEXT
MSG_ERR_LIST_BOX_OBJECT_UNAVAILABLE
<<LISTNAME>>

Examples

Adding items to a list box (with data)