Object Model Reference for GUI Testing > Flex > Click Method

FlexTreeView Object

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

Common Method CaptureBitmap Saves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method Check Checks whether the actual value of an item matches the expected value.
Common Method CheckProperty Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjects Returns the collection of child objects contained within the object.
Method Click Clicks an object.
Method Collapse Hides sub-nodes of the specified node in the expanded tree-view control.
DblClick Double clicks an object.
Method Expand Displays hidden sub-nodes of the specified node in the tree-view control.
Method GetItemChildObjects Returns the collection of child objects contained within the specified tree-view node.
Common Method GetROProperty Returns the current value of the description properties from the object in the application.
Common Method GetTOProperties Returns the collection of properties and values used to identify the object.
Common Method GetTOProperty Returns the value of the specified description properties from the test object description.
Common Method Output Retrieves the current value of an item and stores it in a specified location.
Common Method RefreshObject Instructs UFT to re-identify the object in the application the next time a step refers to this object.
Method Select Selects a node in the tree-view control.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Common Method ToString Returns a string that represents the test object.
Common Method WaitProperty Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property Exist Checks whether the object currently exists in the open application.

 

Back to top

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


 

Back to top

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 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 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 records the node index.

Example


Back to top

DblClick 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


 

Back to top

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 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 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 records the node index.

Example


 

Back to top

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 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 Unified Functional Testing Object Model Reference.

Return Type

An Object.

IMPORTANT

Example


 

Back to top

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

Example


 

Back to top

See also: