UIAList

Extends UIAObject.

Extends SeSSimulatedObject.

Behavior Pattern: UIAutomationListBehavior

Property Summary

Property Description Getter Setter
ItemCount Number of items. GetItemCount SetItemCount
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 SetSelectedItems
SelectedText Text of the selected item in a single string. GetSelectedText SetSelectedText
SelectionCount Number of selected items. GetSelectionCount SetSelectionCount

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, SetItemCount

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

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

SelectedIndex

Index of the selected element of the object.

Type: number

Accessors: 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.
Optional, Default: ;.

Type: string

Accessors: GetSelectedIndices

SelectedItems

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

Type: string

Accessors: GetSelectedItems, SetSelectedItems

SelectedText

Text of the selected item in a single string.

Type: string

Accessors: GetSelectedText, SetSelectedText

SelectionCount

Number of selected items.

Type: number

Accessors: GetSelectionCount, SetSelectionCount

Action Detail

DoAddSelection(items, separator, itemsType)

Extends selection.

Parameters:

Name Type Description
items number | string array
separator string Separator character.
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(nameCaptionIndex, xOffset, yOffset, clickType)

Performs click on the item

Parameters:

Name Type Description
nameCaptionIndex string | number index or name of the item to be selected.
xOffset number X offset to click within object. Default is a center.
Optional.
yOffset number Y offset to click within object. Default is a center.
Optional.
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
Optional, Default: L.

Returns:

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

DoRemoveSelection(items, separator, itemsType)

Removes selection from specified items.

Parameters:

Name Type Description
items number | string array
separator string Separator character.
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(items, separator, itemsType)

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

Parameters:

Name Type Description
items number | string array
separator string Separator character.
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.