This page is maintained for older versions of Rapise only. The latest documentation can be found at: https://rapisedoc.inflectra.com
UIATree

UIATree

Top  Previous 

 

Extends UIAObject. Extends SeSSimulatedObject.

 

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

pathType

string

Path type. Can be one of 'name', 'id' or 'index'.
Optional, Default: name.

 

Type: boolean

 

Accessors: GetChecked, SetChecked

 

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

pathType

string

Path type. Can be one of 'name', 'id' or 'index'.
Optional, Default: name.

 

Type: object

 

Accessors: GetChildAt

 

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

pathType

string

Path type. Can be one of 'name', 'id' or 'index'.
Optional, Default: name.

 

Type: string|boolean

 

Accessors: GetChildrenCount

 

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

pathType

string

Path type. Can be one of 'name', 'id' or 'index'.
Optional, Default: name.

 

Type: boolean

 

Accessors: GetExpanded, SetExpanded

 

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

pathType

string

Path type. Can be one of 'name', 'id' or 'index'.
Optional, Default: name.

 

Type: string|boolean

 

Accessors: GetNodeText

 

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

pathType

string

Path type. Can be one of 'name', 'id' or 'index'.
Optional, Default: name.

 

Type: boolean

 

Accessors: GetSelected, SetSelected

 

Action Detail

 

DoClickNode(path, separator, pathType)

Clicks specific node in the tree.

 

Parameters:

 

Name

Type

Description

path

string

Path of the node

separator

string

Separator character.
Optional, Default: ;.

pathType

string

Path type. Can be one of 'name', 'id' or 'index'.
Optional, Default: name.

 

Returns:

 

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

 

DoCollapse(path, separator, pathType)

Collapses specific node in the tree.

 

Parameters:

 

Name

Type

Description

path

string

Path of the node

separator

string

Separator character.
Optional, Default: ;.

pathType

string

Path type. Can be one of 'name', 'id' or 'index'.
Optional, Default: name.

 

Returns:

 

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

 

DoExpand(path, separator, pathType)

Expands specific node in the tree.

 

Parameters:

 

Name

Type

Description

path

string

Path of the node

separator

string

Separator character.
Optional, Default: ;.

pathType

string

Path type. Can be one of 'name', 'id' or 'index'.
Optional, Default: name.

 

Returns:

 

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

 

DoSelectItem(path, separator, pathType)

Selects specified item in the tree.

 

Parameters:

 

Name

Type

Description

path

string

Path of the node

separator

string

Separator character.
Optional, Default: ;.

pathType

string

Path type. Can be one of 'name', 'id' or 'index'.
Optional, Default: name.

 

Returns:

 

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