MSComCtlTreeView20

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

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

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

DoClickNode(path, separator, pathType)

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.

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.