SftTree¶
This behavior pattern implements standard behavior for Tree control.
Extends ActiveXObject
Extends SeSSimulatedObject
Behavior Pattern: SftTreeBehavior
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. 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('SomeSftTree').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('SomeSftTree').GetExpanded(path, separator, pathType)
SeS('SomeSftTree').SetExpanded(/**boolean*/ value, path, separator, pathType)
ItemsCount¶
Number of rows in the table.
Type: number
Accessors: GetItemsCount
value = SeS('SomeSftTree').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. 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: GetNode
value = SeS('SomeSftTree').GetNode(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". |
| column | number | Zero-based index of a column. Optional, Default: "0". |
Type: string|boolean
Accessors: GetNodeText, SetNodeText
value = SeS('SomeSftTree').GetNodeText(path, separator, pathType, column)
SeS('SomeSftTree').SetNodeText(/**string*/ value, path, separator, pathType, column)
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('SomeSftTree').GetSelected(path, separator, pathType)
SeS('SomeSftTree').SetSelected(/**boolean*/ value, path, separator, pathType)
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
value = SeS('SomeSftTree').GetSiblingsAfter(path, separator, pathType)
Action Detail¶
DoClickNode¶
Clicks specific node in the tree.
SeS('SomeSftTree').DoClickNode(path, separator, pathType, column, clickType, xOffset, yOffset)
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". |
| 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 Possible values: "L", "LD", "R", "RD", "M", "MD", "N" Optional, Default: "L". |
| xOffset | number | X offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the width. Optional. |
| yOffset | number | Y offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the height. Optional. |
Returns:
boolean: 'true' if success, 'false' otherwise.
DoCollapse¶
Collapses specific node in the tree.
SeS('SomeSftTree').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('SomeSftTree').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.
DoFullText¶
Returns text representation of the table.
SeS('SomeSftTree').DoFullText(fileName)
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.