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

DXTreeList

Top  Previous  Next

 

DevXpress TreeList. Extends ManagedObject. Extends SeSSimulatedObject.

 

Behavior Pattern: DXTreeListBehavior

 

Property Summary

 

Property

Description

Getter

Setter

CellText

Cell text for the cell specified by 'rowPath' and 'col'.

GetCellText


Checked

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

GetChecked


ChildrenCount

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

GetChildrenCount


ColumnCount

Number of columns in current grid.

GetColumnCount


ColumnName

Caption of a column.

GetColumnName


Expanded

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

GetExpanded


IndexPath

Index path of the specified or selected tree node i.e.

GetIndexPath


NodeText

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

GetNodeText


RowCount

Number of rows in current grid.

GetRowCount


Selected

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

GetSelected


Text

;-combined text of all selected nodes.

GetText


 

Action Summary

 

Action

Description

DoClickCell

Click the cell specified by row name or index and column name or index

DoClickNode

Clicks specific node in the tree.

DoCollapse

Collapses specific node in the tree.

DoExpand

Expands specific node in the tree.

DoSetCheck

Set 'checked' state of the specified node

 

Property Detail

 

CellText

Cell text for the cell specified by 'rowPath' and 'col'.

 

Getter Parameters:

 

Name

Type

Description

rowPath

string |
number

Path of the top level node to select. If integer number is passed then the top level node is searched by index.

col

number |
string

Column index or column name. Default is 0
Optional.

 

Type: string

 

Accessors: GetCellText

 

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

 

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

 

ColumnCount

Number of columns in current grid.

 

Type: number

 

Accessors: GetColumnCount

 

ColumnName

Caption of a column.

 

Getter Parameters:

 

Name

Type

Description

col

number

Zero-based index of the column.

 

Type: string

 

Accessors: GetColumnName

 

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

 

IndexPath

Index path of the specified or selected tree node i.e. string in form '0;5;2;1;6', 'false' if fails

 

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

 

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

 

RowCount

Number of rows in current grid.

 

Type: number

 

Accessors: GetRowCount

 

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

 

Text

;-combined text of all selected nodes.

 

Type: string

 

Accessors: GetText

 

Action Detail

 

DoClickCell(rowPath, col, xOffset, yOffset)

Click the cell specified by row name or index and column name or index

 

Parameters:

 

Name

Type

Description

rowPath

string |
number

Path of the top level node to select. If integer number is passed then the top level node is searched by index.

col

number |
string

Column index or column name

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.

 

DoClickNode(path, separator, pathType, column, 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.

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.

 

DoSetCheck(bcheck, path, separator, pathType)

Set 'checked' state of the specified node

 

Parameters:

 

Name

Type

Description

bcheck

boolean

Check state to set

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.