Skip to content

UIAList

UIAutomation UIAList.

Extends UIAObject

Extends SeSSimulatedObject

Behavior Pattern: UIAutomationListBehavior

Property Summary

Property Description Getter Setter
ItemCount Number of items. GetItemCount
ItemIndexByName Returns item index by its name. GetItemIndexByName
ItemNameByIndex Returns item name by its index. GetItemNameByIndex
SelectedIndex Index of the selected element of the object. GetSelectedIndex
SelectedIndices Returns string of indexes delimited by separator or array of indexes of selected elements. GetSelectedIndices
SelectedItems Text of all the selected items in a single string. GetSelectedItems
SelectedText Text of the selected item in a single string. GetSelectedText SetSelectedText
SelectionCount Number of selected items. GetSelectionCount

Action Summary

Action Description
DoAddSelection Extends selection.
DoClickItem Performs click on the item
DoRemoveSelection Removes selection from specified items.
DoSelectItem Selects items of this object.

Property Detail

ItemCount

Number of items.

Type: number

Accessors: GetItemCount

value = SeS('SomeUIAList').GetItemCount()

ItemIndexByName

Returns item index by its name. 'false' if name is not found.

Getter Parameters:

Name Type Description
name string

Type: number|boolean

Accessors: GetItemIndexByName

value = SeS('SomeUIAList').GetItemIndexByName(name)

ItemNameByIndex

Returns item name by its index.'false' if name is not found.

Getter Parameters:

Name Type Description
index number Index of the item

Type: string|boolean

Accessors: GetItemNameByIndex

value = SeS('SomeUIAList').GetItemNameByIndex(index)

SelectedIndex

Index of the selected element of the object.

Type: number

Accessors: GetSelectedIndex

value = SeS('SomeUIAList').GetSelectedIndex()

SelectedIndices

Returns string of indexes delimited by separator or array of indexes of selected elements.

Getter Parameters:

Name Type Description
asArray boolean If set to true, function returns an array.
separator string Separator character. Possible values: ";", ",", "\", "/"
Optional, Default: ";".

Type: string

Accessors: GetSelectedIndices

value = SeS('SomeUIAList').GetSelectedIndices(asArray, separator)

SelectedItems

Text of all the selected items in a single string. Items are divided by ';' separator.

Type: string

Accessors: GetSelectedItems

value = SeS('SomeUIAList').GetSelectedItems()

SelectedText

Text of the selected item in a single string.

Type: string

Accessors: GetSelectedText, SetSelectedText

value = SeS('SomeUIAList').GetSelectedText()

SeS('SomeUIAList').SetSelectedText(itemtext)

SelectionCount

Number of selected items.

Type: number

Accessors: GetSelectionCount

value = SeS('SomeUIAList').GetSelectionCount()

Action Detail

DoAddSelection

Extends selection.

SeS('SomeUIAList').DoAddSelection(items, separator, itemsType)

Parameters:

Name Type Description
items number | string | array Can be one of the following:
1. Number, index of an item.
2. String, item names delimited with separator.
3. String, item indexes delimited with separator.
4. Array of item names.
5. Array of item indexes.
separator string Separator character. Possible values: ";", ",", "\", "/"
Optional, Default: ";".
itemsType string If it is 'name' and 'items' parameter is of Stringtype then 'items' parameter is treated as separated item names. If it is'index' and 'items' parameter is of String type then'items' parameter istreated as separated item indexes. If any other value is passed as 'itemsType'the behavior is undefined.
Optional.

Returns:

boolean: 'true' if success, 'false' otherwise.

DoClickItem

Performs click on the item

SeS('SomeUIAList').DoClickItem(nameCaptionIndex, clickType, xOffset, yOffset)

Parameters:

Name Type Description
nameCaptionIndex string | number index or name of the item to be selected.
clickType string Type of click, can be one of "L" - left click, "LD" - double left click, "R" - right click, "RD" - double right click, "M" - middle click, "MD" - double middle click, "N" - don't click Possible values: "L", "LD", "R", "RD", "M", "MD", "N"
Optional, Default: "L".
xOffset number X offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the width.
Optional.
yOffset number Y offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the height.
Optional.

Returns:

boolean: 'true' if successful, 'false' otherwise.

DoRemoveSelection

Removes selection from specified items.

SeS('SomeUIAList').DoRemoveSelection(items, separator, itemsType)

Parameters:

Name Type Description
items number | string | array Can be one of the following:
1. Number, index of an item.
2. String, item names delimited with separator.
3. String, item indexes delimited with separator.
4. Array of item names.
5. Array of item indexes.
separator string Separator character. Possible values: ";", ",", "\", "/"
Optional, Default: ";".
itemsType string If it is 'name' and 'items' parameter is of Stringtype then 'items' parameter is treated as separated item names. If it is'index' and 'items' parameter is of String type then'items' parameter istreated as separated item indexes. If any other value is passed as 'itemsType'the behavior is undefined.
Optional.

Returns:

boolean: 'true' if success, 'false' otherwise.

DoSelectItem

Selects items of this object. First it clears existing selection.

SeS('SomeUIAList').DoSelectItem(items, separator, itemsType)

Parameters:

Name Type Description
items number | string | array Can be one of the following:
1. Number, index of an item.
2. String, item names delimited with separator.
3. String, item indexes delimited with separator.
4. Array of item names.
5. Array of item indexes.
separator string Separator character. Possible values: ";", ",", "\", "/"
Optional, Default: ";".
itemsType string If it is 'name' and 'items' parameter is of Stringtype then 'items' parameter is treated as separated item names. If it is'index' and 'items' parameter is of String type then'items' parameter istreated as separated item indexes. If any other value is passed as 'itemsType'the behavior is undefined.
Optional.

Returns:

boolean: 'true' if success, 'false' otherwise.