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 ActiveXObject. 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

ItemsCount

Number of rows in the table.

GetItemsCount


Node

Selected node or a node specified by the input parameters.

GetNode


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

SiblingsAfter

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

GetSiblingsAfter


 

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.

 

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

 

ItemsCount

Number of rows in the table.

 

Type: number

 

Accessors: GetItemsCount

 

Node

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: object

 

Accessors: GetNode

 

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.

column

number

Zero-based index of a column.
Optional, Default: 0.

 

Type: string|boolean

 

Accessors: GetNodeText, SetNodeText

 

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

 

SiblingsAfter

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

 

Getter Parameters:

 

Name

Type

Description

path


 

separator


 

pathType


 

 

Type: number

 

Accessors: GetSiblingsAfter

 

Action Detail

 

DoClickNode(path, separator, pathType, column, clickType, xOffset, yOffset)

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.

column

number |
string

Column index or column name. Default is 0
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.

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.

 

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.

 

DoFullText(fileName)

Returns text representation of the table.

 

Parameters:

 

Name

Type

Description

fileName

string

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

 

Returns:

 

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