Share this page
FlexTreeView Object
Note: Following the retirement of the Adobe Flash Player, UFT One no longer supports the Flex Add-in out of the box.
If you require the Flex Add-in, contact OpenText Support.
Description
A Flex tree-view control.
Operations
The sections below list the built-in methods and properties that you can use as operations for the FlexTreeView object.
Note: You can also view a list and descriptions of the FlexTreeView description properties, for use in object repository descriptions, programmatic descriptions, checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.
Methods
 CaptureBitmap | Saves a screen capture of the object as a .png or .bmp image using the specified file name. |
| Check | Checks whether the actual value of an item matches the expected value. |
| CheckProperty | Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout. |
| ChildObjects | Returns the collection of child objects contained within the object. |
| GetAllROProperties | Returns the collection of properties and current values from the object in the application. |
 Click | Clicks an object. |
| Collapse | Hides sub-nodes of the specified node in the expanded tree-view control. |
| DblClick | Double clicks an object. |
| Expand | Displays hidden sub-nodes of the specified node in the tree-view control. |
| GetItemChildObjects | Returns the collection of child objects contained within the specified tree-view node. |
| GetROProperty | Returns the current value of the description property from the object in the application. |
| GetTOProperties | Returns the collection of properties and values used to identify the object. |
| GetTOProperty | Returns the value of the specified description property from the test object description. |
| Highlight | Highlights the object in the application. |
| Output | Retrieves the current value of an item and stores it in a specified location. |
| RefreshObject | Instructs UFT One to re-identify the object in the application the next time a step refers to this object. |
| Select | Selects a node in the tree-view control. |
| SetTOProperty | Sets the value of the specified description property in the test object description. |
| ToString | Returns a string that represents the test object. |
| WaitProperty | Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step. |
Properties
 Exist | Checks whether the object currently exists in the open application. |
Click Method
Description
Clicks an object.
Syntax
object.Click ([X], [Y], [BUTTON])
Arguments
| Parameter | Description |
|---|---|
| X |
Optional. An integer value. The x-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = -9999 |
| Y |
Optional. An integer value. The y-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = -9999 |
| BUTTON |
Optional. A predefined constant or number. The mouse button used to click the object. Default value = micLeftBtn |
Return Type
None.
Example
Click the OK Button (VBScript)
'The following example uses the Click method to click
'the OK button, at coordinates 15,20.
With Browser("Browser").Page("Page").FlexWindow("AllControls")
.FlexButton("OK").Click 15, 20, micLeftBtn
End With
Collapse Method
Description
Hides sub-nodes of the specified node in the expanded tree-view control.
Syntax
object.Collapse (item)
Arguments
| Parameter | Description |
|---|---|
| item |
Required. A Variant. The full path of the node to select in the tree. The path is a list of the node names (with quotes) separated by semicolons (;), or numeric index values. Index values begin with 0. Note 1: If the node is identified by its full path, the default path delimiter is ';'. For example, "Root;Child1;Child2". If the default path delimiter character is used in a node name, you can change the delimiter character for your test or component using the "TreePathDelimiter" setting value. For example, Setting.Item("TreePathDelimiter") = "#". You must restart the application you are testing after changing this setting. Note 2: If the node is identified by its numeric index, UFT One counts only the expanded nodes. Child nodes of a collapsed parent node are not counted. The first root node in a tree-view control is numbered 0. If you need to access a sub-node of the tree that is not expanded, use the Expand Method and then use the index number. Note 3: The same node can have different index numbers, depending on what nodes in the tree are expanded. |
Return Type
None.
IMPORTANT
When recording operations on tree view nodes, UFT One records the node label value for the Item argument if the label has a value and that value is unique in the tree. Otherwise UFT One records the node index.
Example
Collapse a Node in a Tree (VBScript)
'The following example uses the Collapse method to collapse
'the C: node of the FlexTreeView tree.
With Browser("Browser").Page("Page").FlexWindow("AllControls")
.FlexTreeView("FlexTreeView").Collapse "C:"
End WithDblClick Method
Description
Double clicks an object.
Syntax
object.Click ([X], [Y], [BUTTON])
Arguments
| Parameter | Description |
|---|---|
| X |
Optional. An integer value. The x-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = -9999 |
| Y |
Optional. An integer value. The y-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = -9999 |
| BUTTON |
Optional. A predefined constant or number. The mouse button used to click the object. Default value = micLeftBtn |
Return Type
None.
Example
Click the OK Button (VBScript)
'The following example uses the Click method to click
'the OK button, at coordinates 15,20.
With Browser("Browser").Page("Page").FlexWindow("AllControls")
.FlexButton("OK").DblClick 15, 20, micLeftBtn
End With
Expand Method
Description
Displays hidden sub-nodes of the specified node in the tree-view control.
Syntax
object.Expand (item)
Arguments
| Parameter | Description |
|---|---|
| item |
Required. A Variant. The full path of the node to select in the tree. The path is a list of the node names (with quotes) separated by semicolons (;), or numeric index values. Index values begin with 0. Note 1: If the node is identified by its full path, the default path delimiter is ';'. For example, "Root;Child1;Child2". If the default path delimiter character is used in a node name, you can change the delimiter character for your test or component using the "TreePathDelimiter" setting value. For example, Setting.Item("TreePathDelimiter") = "#". You must restart the application you are testing after changing this setting. Note 2: If the node is identified by its numeric index, UFT One counts only the expanded nodes. Child nodes of a collapsed parent node are not counted. The first root node in a tree-view control is numbered 0. If you need to access a sub-node of the tree that is not expanded, use the Expand Method and then use the index number. Note 3: The same node can have different index numbers, depending on what nodes in the tree are expanded. |
Return Type
None.
IMPORTANT
When recording operations on tree view nodes, UFT One records the node label value for the Item argument if the label has a value and that value is unique in the tree. Otherwise UFT One records the node index.
Example
'The following example uses the Collapse method to collapse (VBScript)
'The following example uses the Expand method to expand the
'Program Files sub-node of the C: node, in the FlexTreeView
'tree.
With Browser("Browser").Page("Page").FlexWindow("AllControls")
.FlexTreeView("FlexTreeView").Expand "C:;Program Files"
End With
GetItemChildObjects Method
Description
Returns the collection of child objects contained within the specified tree-view node.
Syntax
object.GetItemChildObjects (item, [Description])
Arguments
| Parameter | Description |
|---|---|
| item |
Required. A Variant. The full path of the node to select in the tree. The path is a list of the node names (with quotes) separated by semicolons (;), or numeric index values. Index values begin with 0. Note 1: If the node is identified by its full path, the default path delimiter is ';'. For example, "Root;Child1;Child2". If the default path delimiter character is used in a node name, you can change the delimiter character for your test or component using the "TreePathDelimiter" setting value. For example, Setting.Item("TreePathDelimiter") = "#". You must restart the application you are testing after changing this setting. Note 2: If the node is identified by its numeric index, UFT One counts only the expanded nodes. Child nodes of a collapsed parent node are not counted. The first root node in a tree-view control is numbered 0. If you need to access a sub-node of the tree that is not expanded, use the Expand Method and then use the index number. Note 3: The same node can have different index numbers, depending on what nodes in the tree are expanded. |
| Description |
Optional. An Object. The Properties (collection) object containing the description of the child objects you want to retrieve. Tip: You can retrieve a Properties collection using the GetTOProperties method or you can build a Properties collection object using the Description object. For more information on the Description object, refer to the Utility Objects section of the UFT One Object Model Reference. |
Return Type
An Object.
IMPORTANT
- Use this method to access objects that are embedded inside of Flex tree view nodes, such as check boxes, radio buttons, and toggle buttons.
- You may want to call the Select method to activate the node before accessing its content, as this sometimes changes the embedded objects.
- The GetItemChildObjects method may not return a child object for plain text contained in a tree view node. To retrieve this type of data, use the GetROProperty method and retrieve the selection or all_items properties.
Example
Print a List of the Objects Embedded in a Tree-View Item (Visual Basic)
'The following example uses the GetItemChildObjects method to retrieve the objects
'contained in the node in the FlexTreeView, and then prints the objects in a numbered list.
'First, click the node to activate it and show the controls it contains
Browser("Browser").Page("Page").FlexWindow("AllControls").FlexTreeView("FlexTree").Select "English"
Wait(1)
'Next, retrieve the child test objects
Set collection = Browser("Browser").Page("Page").FlexWindow("AllControls").FlexTreeView("FlexTree").GetItemChildObjects("English")
Print collection.Count
For Iterator = 0 To collection.Count-1 Step 1
Print Iterator & ":" & collection(Iterator).ToString
Next
Select Method
Description
Selects a node in the tree-view control.
Syntax
object.Select (item, [X], [Y])
Arguments
| Parameter | Description |
|---|---|
| item |
Required. A Variant. The full path of the node to select in the tree. The path is a list of the node names (with quotes) separated by semicolons (;), or numeric index values. Index values begin with 0. Note 1: If the node is identified by its full path, the default path delimiter is ';'. For example, "Root;Child1;Child2". If the default path delimiter character is used in a node name, you can change the delimiter character for your test or component using the "TreePathDelimiter" setting value. For example, Setting.Item("TreePathDelimiter") = "#". You must restart the application you are testing after changing this setting. Note 2: If the node is identified by its numeric index, UFT One counts only the expanded nodes. Child nodes of a collapsed parent node are not counted. The first root node in a tree-view control is numbered 0. If you need to access a sub-node of the tree that is not expanded, use the Expand Method and then use the index number. Note 3: The same node can have different index numbers, depending on what nodes in the tree are expanded. |
| X |
Optional. An integer value. The x-coordinate of the location to click when selecting the item. Note that the specified coordinates are relative to the upper left corner of the item. The default is the center of the item. Default value = -9999 |
| Y |
Optional. An integer value. The y-coordinate of the location to click when selecting the item. Note that the specified coordinates are relative to the upper left corner of the item. The default is the center of the item. Default value = -9999 |
Return Type
None.
IMPORTANT
- When recording operations on tree view nodes, UFT One records the node label value for the Item argument if the label has a value and that value is unique in the tree. Otherwise UFT One records the node index.
- UFT One does not record coordinates for this method.
- If the tree-view item contains embedded objects and you want to avoid clicking them when selecting the item, provide the x and y arguments to specify a location to click inside the item.
- This method is also useful for bringing the item into view. For example, before calling GetItemChildObjects Method.
Example
Select a Node in a Tree (VBScript)
'The following example uses the Select method to select the first
'node of the FlexTreeView tree.
With Browser("Browser").Page("Page").FlexWindow("AllControls")
.FlexTreeView("FlexTreeView").Select 0
End With
See also:
