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

SftTree

Top  Previous 

 

Extends SeSSimulatedObject.

 

Behavior Pattern: ActiveXSftTreeBehavior

 

Property Summary

 

Property

Description

Getter

Setter

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

SetNodeText

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.

DoFullText

Returns text representation of the table.

 

Property Detail

 

ChildrenCount

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

Accessors: GetChildrenCount

 

Expanded

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

Accessors: GetExpanded, SetExpanded

 

NodeText

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

Accessors: GetNodeText, SetNodeText

 

Selected

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

Accessors: GetSelected, SetSelected

 

Action Detail

 

DoClickNode(path, sep, pathType, colInd, clickType, xOffset, yOffset)

Clicks specific node in the tree.

 

Parameters:

 

Name

Type

Description

path

string

Path of the node

sep


 

pathType

string

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

colInd


 

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.

xOffset

number

X offset to click within node. Default is a center.
Optional.

yOffset

number

Y offset to click within node. Default is a center.
Optional.

 

Returns:

 

'true' if success, 'false' otherwise.

 

DoCollapse(path, sep, pathType)

Collapses specific node in the tree.

 

Parameters:

 

Name

Type

Description

path

string

Path of the node

sep


 

pathType

string

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

 

Returns:

 

'true' if success, 'false' otherwise.

 

DoExpand(path, sep, pathType)

Expands specific node in the tree.

 

Parameters:

 

Name

Type

Description

path

string

Path of the node

sep


 

pathType

string

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

 

Returns:

 

'true' if success, 'false' otherwise.

 

DoFullText(saveToFile, fileName)

Returns text representation of the table.

 

Parameters:

 

Name

Type

Description

saveToFile


 

fileName

string

Name of a file that should hold text representation of the grid.
Optional.

 

Returns:

 

Text representation of the grid, 'true' if the file was successfully written, 'false' otherwise.