MSComCtlTreeView20¶
ComCtl TreeView20 Control
Extends ActiveXObject
Extends SeSSimulatedObject
Behavior Pattern: MSComCtlTreeView20Behavior
Property Summary¶
| Property | Description | Getter | Setter |
|---|---|---|---|
| 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 | |
| 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 | |
| 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 |
|---|---|
| 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¶
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. 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: GetChecked
value = SeS('SomeMSComCtlTreeView20').GetChecked(path, separator, pathType)
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('SomeMSComCtlTreeView20').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
value = SeS('SomeMSComCtlTreeView20').GetExpanded(path, separator, pathType)
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. 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: GetIndexPath
value = SeS('SomeMSComCtlTreeView20').GetIndexPath(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". |
Type: string|boolean
Accessors: GetNodeText
value = SeS('SomeMSComCtlTreeView20').GetNodeText(path, separator, pathType)
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
value = SeS('SomeMSComCtlTreeView20').GetSelected(path, separator, pathType)
Text¶
;-combined text of all selected nodes.
Type: string
Accessors: GetText
value = SeS('SomeMSComCtlTreeView20').GetText()
Action Detail¶
DoClickNode¶
Clicks specific node in the tree.
SeS('SomeMSComCtlTreeView20').DoClickNode(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.
DoCollapse¶
Collapses specific node in the tree.
SeS('SomeMSComCtlTreeView20').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('SomeMSComCtlTreeView20').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.
DoSetCheck¶
Set 'checked' state of the specified node
SeS('SomeMSComCtlTreeView20').DoSetCheck(bcheck, path, separator, pathType)
Parameters:
| Name | Type | Description |
|---|---|---|
| bcheck | boolean | Check state to set |
| 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.