UIATree¶

UIAutomation UIATree.

Behavior Pattern: UIAutomationTreeBehavior

Property Summary¶

Property	Description	Getter	Setter
Checked	Checked state of the selected node or a node specified by the input parameters.	GetChecked	SetChecked
ChildAt	Child at index of the selected node or a node specified by the input parameters.	GetChildAt
ChildrenCount	Number of children of the selected node or a node specified by the input parameters.	GetChildrenCount
Expanded	Expanded state of the selected node or a node specified by the input parameters.	GetExpanded	SetExpanded
NodeText	Text of the selected node or a node specified by the input parameters.	GetNodeText
Selected	Selected state of the selected node or a node specified by the input parameters	GetSelected	SetSelected

Action Summary¶

Action	Description
DoClickNode	Clicks specific node in the tree.
DoCollapse	Collapses specific node in the tree.
DoExpand	Expands specific node in the tree.
DoSelectItem	Selects specified item in the tree.

Property Detail¶

Checked¶

Checked state of the selected node or a node specified by the input parameters.

Getter Parameters:

Name	Type	Description
path	string	Path of the node
separator	string	Separator character. Possible values: ";", ",", "\", "/" Optional, Default: ";".
pathType	string	Path type. Can be one of 'name', 'id' or 'index'. Possible values: "name", "index", "id" Optional, Default: "name".

Type: boolean

Accessors: GetChecked, SetChecked

value = SeS('SomeUIATree').GetChecked(path, separator, pathType)

SeS('SomeUIATree').SetChecked(path, /**boolean*/ value, separator, pathType)

ChildAt¶

Child at index of the selected node or a node specified by the input parameters.

Getter Parameters:

Name	Type	Description
path	string	Path of the node
index	number
separator	string	Separator character. Possible values: ";", ",", "\", "/" Optional, Default: ";".
pathType	string	Path type. Can be one of 'name', 'id' or 'index'. Possible values: "name", "index", "id" Optional, Default: "name".

Type: object

Accessors: GetChildAt

value = SeS('SomeUIATree').GetChildAt(path, index, separator, pathType)

ChildrenCount¶

Number of children of the selected node or a node specified by the input parameters.

Getter Parameters:

Name	Type	Description
path	string	Path of the node
separator	string	Separator character. Possible values: ";", ",", "\", "/" Optional, Default: ";".
pathType	string	Path type. Can be one of 'name', 'id' or 'index'. Possible values: "name", "index", "id" Optional, Default: "name".

Type: string|boolean

Accessors: GetChildrenCount

value = SeS('SomeUIATree').GetChildrenCount(path, separator, pathType)

Expanded¶

Expanded state of the selected node or a node specified by the input parameters.

Getter Parameters:

Name	Type	Description
path	string	Path of the node
separator	string	Separator character. Possible values: ";", ",", "\", "/" Optional, Default: ";".
pathType	string	Path type. Can be one of 'name', 'id' or 'index'. Possible values: "name", "index", "id" Optional, Default: "name".

Type: boolean

Accessors: GetExpanded, SetExpanded

value = SeS('SomeUIATree').GetExpanded(path, separator, pathType)

SeS('SomeUIATree').SetExpanded(path, separator, pathType)

NodeText¶

Text of the selected node or a node specified by the input parameters.

Getter Parameters:

Name	Type	Description
path	string	Path of the node
separator	string	Separator character. Possible values: ";", ",", "\", "/" Optional, Default: ";".
pathType	string	Path type. Can be one of 'name', 'id' or 'index'. Possible values: "name", "index", "id" Optional, Default: "name".

Type: string|boolean

Accessors: GetNodeText

value = SeS('SomeUIATree').GetNodeText(path, separator, pathType)

Selected¶

Selected state of the selected node or a node specified by the input parameters

Getter Parameters:

Name	Type	Description
path	string	Path of the node
separator	string	Separator character. Possible values: ";", ",", "\", "/" Optional, Default: ";".
pathType	string	Path type. Can be one of 'name', 'id' or 'index'. Possible values: "name", "index", "id" Optional, Default: "name".

Type: boolean

Accessors: GetSelected, SetSelected

value = SeS('SomeUIATree').GetSelected(path, separator, pathType)

SeS('SomeUIATree').SetSelected(path, separator, pathType)

Action Detail¶

DoClickNode¶

Clicks specific node in the tree.

SeS('SomeUIATree').DoClickNode(path, separator, pathType)

Parameters:

Name	Type	Description
path	string	Path of the node
separator	string	Separator character. Possible values: ";", ",", "\", "/" Optional, Default: ";".
pathType	string	Path type. Can be one of 'name', 'id' or 'index'. Possible values: "name", "index", "id" Optional, Default: "name".

Returns:

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

DoCollapse¶

Collapses specific node in the tree.

SeS('SomeUIATree').DoCollapse(path, separator, pathType)

Parameters:

Name	Type	Description
path	string	Path of the node
separator	string	Separator character. Possible values: ";", ",", "\", "/" Optional, Default: ";".
pathType	string	Path type. Can be one of 'name', 'id' or 'index'. Possible values: "name", "index", "id" Optional, Default: "name".

Returns:

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

DoExpand¶

Expands specific node in the tree.

SeS('SomeUIATree').DoExpand(path, separator, pathType)

Parameters:

Name	Type	Description
path	string	Path of the node
separator	string	Separator character. Possible values: ";", ",", "\", "/" Optional, Default: ";".
pathType	string	Path type. Can be one of 'name', 'id' or 'index'. Possible values: "name", "index", "id" Optional, Default: "name".

Returns:

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

DoSelectItem¶

Selects specified item in the tree.

SeS('SomeUIATree').DoSelectItem(path, separator, pathType)

Parameters:

Name	Type	Description
path	string	Path of the node
separator	string	Separator character. Possible values: ";", ",", "\", "/" Optional, Default: ";".
pathType	string	Path type. Can be one of 'name', 'id' or 'index'. Possible values: "name", "index", "id" Optional, Default: "name".

Returns:

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