List Box Object - Select

Selects one or more items in a List Box Object. This has exactly the same effect as when the user selects additional items in the list box (for example, by shift-clicking or ctrl-clicking on the items).

TIP

	You can also use this action to select no items, i.e. to deselect all of the items. This is especially useful when you want to "reset" a List Box Object in order to make brand-new selections in it.

NOTE

	This action will trigger the On Selection Changed event for the List Box Object.

Action ID:
Action Category:
Action List Syntax:

122
List Box Object
ListBoxObject[<<OBJECTNAME>>].Select (<<SELECTTYPE>>)

Settings

List Box

Name:

The name of the List Box Object.

Select

Which items you want to select in the List Box Object. Choose from:

All items	-	Select all of the items in the List Box Object.
No items	-	Select none of the items in the List Box Object—in other words, deselect all of the items in the list. (Use this to "reset" the list box between selections.)
Specific items	-	Select the items listed by index in the Index field.

Index:

The items that you want to select. Depending on which option you select in Select By below, this can either be the zero-based index of the item, or the text of the item itself, or the item's associated data string. To specify multiple items, use a delimited list of indexes, item texts, or data strings.

NOTE

	You can only select multiple items in a List Box Object if its Multiple selection option is enabled. If you try to select multiple items in a List Box Object that has that option disabled, only the last item in your delimited list will be selected. (The action will actually go through your delimited list and select each item, one item at a time.)

This field is only available when the Specific items option 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.

Select By

Whether you want to select items by their indexes, item texts, or associated data strings. (This determines how AutoPlay interprets the text in the Index field.) Choose from:

Index	-	Select each item based on a numeric index.
Item text	-	Select each item based on the text that is visible in the List Box Object.
Item data	-	Select each item by its associated data string.

NOTE

	When selecting multiple items by their text (or data), the List Box Object's Multiple selection option determines what happens when there are multiple items in the List Box with the same text (or data). If multiple selection is enabled, every matching item will be selected. If multiple selection is disabled, only the last matching item will be selected.

Error Codes

Value (%LastErrorNum%)	Simple Message (%LastErrorMsg%)	Verbose Message (%LastErrorDetails%)
0 (OK)
1	MSG_ERR_LIST_BOX_OBJECT_SELECT	MSG_ERR_LIST_BOX_OBJECT_SELECT MSG_ERR_OBJECT_NOT_FOUND <<LISTNAME>>
2	MSG_ERR_LIST_BOX_OBJECT_SELECT	MSG_ERR_LIST_BOX_OBJECT_SELECT MSG_ERR_LIST_BOX_OBJECT_UNAVAILABLE <<LISTNAME>>
3	MSG_ERR_LIST_BOX_OBJECT_SELECT	MSG_ERR_LIST_BOX_OBJECT_SELECT MSG_ERR_MALFORMED_NUMERIC_INDEX <<INDEX>>

Examples

None