TreeView control properties, methods, and events

Interrogated targets that are represented by Studio's ListView control support the general control properties, methods, and events. For more information, see General Windows Control Properties, Methods, and Events. In addition, Studio exposes the following properties, methods, and events that are specific to this control.

 

Properties

Property

Description

Count

Gets the total number of TreeView nodes. For the treeNodeProxy control, this property gets the number of child nodes under the specific node. (Int32 type)

Nodes

Gets a collection of TreeView nodes (IList[] type).

PathSeparator

Gets the character used to delineate child nodes in the path string identifying a particular node. This property also displays in the Properties window.

RootNode

Gets the main (root) node for the TreeView. (TreeNode type)

SelectedNode

Gets the currently selected TreeView node (TreeNode type).

 

Methods

Method

Description

Parameters

Return type

ClickIcon

8.0 SP1 2030 or later

Use this method to select a check box based on the path that you specify.

String path

Boolean

ClickIconByRegEx

8.0 SP1 2030 or later

Use this method to select a check box based on the regex string that you specify.

String regex

Boolean

ClickIconByText

8.0 SP1 2030 or later

Use this method to select a check box based on the string that you specify.

String text

Boolean

ClickNode

Use this method to raise the Click event on the node that you specified using the node path string.

String path

Boolean

ClickNodeByRegex

Use this method to raise the Click event for a node specified by the node path using  text in regex syntax.

String regex

Boolean

ClickNodeByText

Raises the Click event on the node specified by the node text string.

String text

Boolean

CollapseAll

Use this method to collapse all currently expanded nodes.

None

Void

CollapseNode

Use this method to collapse the node selected by the input path parameter.

String path

Boolean

CollapseNodeByRegex

Use this method to collapse the node selected by specifying the node text in regex syntax.

String regex

Boolean

CollapseNodeByText

Use this method to collapse the node selected by the node text input parameter (such as Office).

String text

Boolean

DoubleClickNode

Raises the Double-Click event on the node specified by the node path string.

String path

Boolean

DoubleClickNodeByRegex

Use this method to raise the Double-Click event for a node specified by the node path using text in regex syntax.

String regex

Boolean

DoubleClickNodeByText

Raises the Double-Click event on the node specified by the node text string.

String text

Boolean

EnsureVisible

Use this method to expand the nodes in the TreeView so that the node identified by the path parameter is visible.

String path

Boolean

ExpandAll

Use this method to expand all nodes in the tree (for the TreeView control) or expand all nodes under the currently selected node (for the treeNodeProxy control.

None

Void

ExpandNode

Use this method to expand a node using the path parameter.

String path

Boolean

ExpandNodeByRegex

Use this method to expand a node selected by specifying the node text in regex syntax.

String regex

Boolean

ExpandNodeByText

Use this method to expand a node selected by the node text input parameter.

String text

Boolean

FindNode

Returns the node specified by the expression parameter.

String path

Node

FindNodeByRegex Returns the node specified by the node text in regex syntax. String regex

Node

FindNodeByText

Returns the item specified by the node text parameter.

String text

Node

FindNodeByText
8.0.2023 or later

Returns the item specified by the string text and int column parameters.

String text, int column

Node

FindNodeByText
8.0.2023 or later

Returns the item specified by the string text and string columnName parameters.

String text, string columnName

Node

GetRootItemTextByIndex

Grabs the specified node and returns its name in a string. For index 0 (zero), the returned string is the name of the top most node.

Int32 index

Boolean

SelectNode

Use this method to select a node using the path parameter.

String path

Boolean

SelectNodeByRegex

Use this method to select a node using by specifying node text in regex syntax.

String regex

Boolean

SelectNodeByText

Use this method to select a node using the node text input parameter.

String text

Boolean

SelectRootItemByIndex

Checks if there is a node at the given index and returns a Boolean value. If it exists, True is returned. Otherwise, False is returned.

Int32 index

Boolean

 

Events

Event

Description

NodeClicked

Occurs when the user clicks on a TreeView node.

NodeDoubleClicked

Occurs when the user double-clicks on a TreeView node.

NodeSelected

Occurs when the user selects a TreeView node.

 

 


Privacy | Trademarks | Terms of Use | Feedback

Updated: 18 June 2020

© 2016 - 2020 Pegasystems Inc.  Cambridge, MA All rights reserved.

 

OpenSpan data classification label