VbTreeView Object

Description

A Visual Basic tree-view control.

Operations

The sections below list the built-in methods and properties that you can use as operations for the VbTreeView object.

Note: You can also view a list and descriptions of the VbTreeView 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

Method ActivateActivates (double-clicks) a node in the tree-view control.
Common Method CaptureBitmapSaves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Method CheckItemPropertyChecks whether the specified item property achieves the specified value within the specified timeout.
Common Method CheckPropertyChecks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjectsReturns the collection of child objects contained within the object.
Common Method GetAllROProperties

Returns the collection of properties and current values from the object in the application.

Method ClickClicks the window.
Method CollapseHides the sub-nodes of the specified node in an expanded tree-view control.
Method DblClickDouble-clicks the window.
Method DragPerforms the 'drag' part of a drag and drop operation.
Method DragItemPerforms the 'drag' part of a drag and drop operation on a specified node in a tree-view control.
Method DropPerforms the 'drop' part of a drag and drop operation.
Method DropOnItemCompletes the drag and drop operation by dropping the node onto a specified target node.
Method EditLabelActivates the edit mode for a node in the tree-view control in preparation for changing the node�s name.
Method ExpandDisplays hidden sub-nodes of the specified node in a tree-view control.
Method ExpandAllExpands the node in the tree-view control and all of the nodes below it.
Method GetCheckMarksRetrieves the index value for each node marked as checked.
Method GetContentReturns all of the nodes in the tree-view control.
Method GetItemReturns the value of the node specified by the index.
Method GetItemPropertyReturns a node property in a tree-view control.
Method GetItemsCountReturns the number of nodes in the tree-view control.
Common Method GetROPropertyReturns the current value of the description property from the object in the application.
Method GetSelectionReturns all of the selected nodes in the tree-view control.
Method GetTextLocationChecks whether the specified text string is contained in the specified window area.
Common Method GetTOPropertiesReturns the collection of properties and values used to identify the object.
Common Method GetTOPropertyReturns the value of the specified description property from the test object description.
Common Method HighlightHighlights the object in the application.
Method GetVisibleTextReturns the text from the specified area.
Method MouseMoveMoves the mouse pointer to the designated position inside the window.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method SelectSelects a node from the tree-view control.
Method SetItemStateSets the state of a check box icon of the specified node in a tree-view control.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Common Method ToStringReturns a string that represents the test object.
Method TypeTypes the specified string in the window.
Method WaitItemPropertyWaits until the specified item property achieves the specified value or exceeds the specified timeout before continuing to the next step.
Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property ExistChecks whether the object currently exists in the open application.
Common Property ObjectAccesses the native methods and properties of the Visual Basic object.

Back to top

 

Activate Method

Description

Activates (double-clicks) a node in the tree-view control.

Syntax

object.Activate Item, [BUTTON]

Arguments

ParameterDescription
Item Required. A Variant.
The full path of the node to activate in the tree-view control. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 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") = "#"
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.

BUTTON Optional. A predefined constant or number.
The mouse button used to activate the node.
Default value = micLeftBtn

Return Type

None

Example

                    'The following example uses the Activate method to double-click on the
'Inventory;Drinks (third) node in the MyTree tree.

Window("frmMain").VbTreeView("MyTree").Activate "Inventory;Drinks"
'or

Window("frmMain").VbTreeView("MyTree").Activate 2

Back to top

 

CheckItemProperty Method

Description

Checks whether the specified item property achieves the specified value within the specified timeout.

Syntax

object.CheckItemProperty (Item, PropertyName, PropertyValue, [TimeOut])

Arguments

ParameterDescription
Item Required. A Variant.
The item name (with quotes) or numeric index (without quotes) can denote the item. The first item in a list is numbered 0.
PropertyName Required. A String value.
The name of the item property whose value is checked. The following properties are supported:
Property Name
Description
focused
Indicates whether the tree-view control has the focus in a multiple selection list box.
Possible values:        
       True
       False
selected
Indicates whether the tree-view control is selected.
Possible values:                                    
       True
       False
state
Indicates whether the tree-view control node has a check box, and whether it is selected.
Possible values:
 0--the tree-view control node does not have a check box
 1--the tree-view control node's check box is not selected
 2--the tree-view control node's check box is selected
text
The text of the tree-view control, or "" (empty string) if the tree-view control does not contain any text.
PropertyValue Required. A Variant.
The expected value against which the actual item property value should be checked. You can either use a simple value or you can use a comparison object together with the value to perform more complex comparisons.
TimeOut Optional. An unsigned long integer value.
The time, in milliseconds, within which UFT One should check whether the actual value of the item property matches the specified expected value. If no value is specified, UFT One uses the time set in the Object Synchronization Timeout option in the Run pane of the Test Settings dialog box.

Return Type

A Boolean value.

Returns TRUE if the item property achieves the value, and FALSE if the timeout is reached before the item property achieves the value.

A TRUE return value reports a Passed step to the run results; a FALSE return value reports a Failed step to the run results.

IMPORTANT

If the expected and actual values do not match, an error is reported and the test or component status is changed to failed.

Note: For test run synchronization, or whenever you do not want to fail the test if the expected and actual values do not match, use the WaitItemProperty method.

You can also use comparison objects to perform more complex value comparisons. For example, you can instruct UFT One to check whether a specific item property value is greater than the specified value.

An example of the syntax required when using a comparison object is: Object.CheckItemProperty 2, "text", micNotEqual("John")"

The following comparison objects can be used:

  • micGreaterThan: Greater than; Specifies that UFT One checks whether the item property value is greater than the specified value.
  • micLessThan: Less than; Specifies that UFT One checks whether the item property value is less than the specified value.
  • micGreaterThanOrEqual: Greater than or equal to; Specifies that UFT One checks whether the item property value is greater than or equal to the specified value.
  • micLessThanOrEqual: Less than or equal to; Specifies that UFT One checks whether the item property value is less than or equal to the specified value.
  • micNotEqual: Not equal to; Specifies that UFT One checks whether the item property value is not equal to the specified value.
  • micRegExpMatch: Regular expression; Specifies that UFT One checks whether the item property value achieves a regular expression match with the specified value. Regular expressions are case-sensitive and must match exactly. For example, 'E.*h' matches 'Earth' but not 'The Earth' or 'earth'.

When the types of the expected value and actual value do not match, the comparisons are performed as follows (in this order):

  • Empty values: Empty values may be an uninitialized variable or field (which returns TRUE for the IsNull function in VBscript) or initialized to an empty value (which returns TRUE for the IsEmpty function is VBscript). When trying to compare two arguments when at least one is an empty value, the comparison assumes equality for two uninitialized arguments and for two empty arguments. Any other combination is considered unequal.
    For example:
    dim vEmpty
    Object.CheckItemProperty 2, "text",micNotEqual    (vEmpty) 
    will not wait for the timeout (because the 'text' property value is an empty string and the argument passed to micNotEqual is an empty value, and so micNotEqual finds them not equal and returns TRUE).
  • String values: When trying to compare a string value with non-string value, the string value is converted to the non-string type and then compared. If the string value cannot be converted to the non-string type, the comparison assumes the values are not equal.
    For example:
    Object.CheckItemProperty 2, "text", micGreaterThan("8")"
    will not wait for the timeout if the 'text' property value is '16' (because micGreaterThan finds 16 to be greater than 8 and returns TRUE), but will wait if the 'text' property value is 'a' (because 'a' cannot be converted to a number).
  • Boolean values: When trying to compare a Boolean value with non-boolean value, the non-boolean value is converted to a boolean value and then compared. The conversion method assumes that any integer value other than '0' is TRUE, and that '0' alone is FALSE. If the conversion fails to produce a boolean value (for example, if the value is 'abc'), the comparison result will be FALSE (note that for the WaitProperty method this result would instruct UFT One to keep waiting). If the conversion succeeds, the method compares the two boolean values according to the comparison logic.
  • Other value types: When other value types do not match, they are compared under the assumption that different types are not equal (nor greater than or less than each other).

Back to top

 

Click Method

Description

Clicks the window.

Syntax

object.Click [X], [Y], [BUTTON]

Arguments

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


Tip: You can enter micNoCoordinate (-9999) for the x and y argument values if you want to enter a value for the button argument without specifying x- and y- coordinates for the click.


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

                    'The following example uses the Click method to click a right mouse
'button at coordinates 47, 131 on the OK button.

VbWindow("frmLogin").VbButton("OK").Click 47, 131,

Back to top

 

Collapse Method

Description

Hides the sub-nodes of the specified node in an expanded tree-view control.

Syntax

object.Collapse Item

Arguments

ParameterDescription
Item Required. A Variant.
The full path of the node to collapse in the tree-view control. The node value (with quotes) or numeric index (without quotes) can denote the node. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. 

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") = "#"
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.

Return Type

None

Example

                    'The following example uses the Collapse method to collapses the "Ins"
'item.

Window("frmMain").VbTreeView("SysTreeView32").Collapse "Ins"

Back to top

 

DblClick Method

Description

Double-clicks the window.

Syntax

object.DblClick X, Y, [BUTTON]

Arguments

ParameterDescription
X Required. An integer value.
The x-coordinate of the double-click. Note that the specified coordinates are relative to the upper left corner of the object.
Y Required. An integer value.
The y-coordinate of the double-click. Note that the specified coordinates are relative to the upper left corner of the object.
BUTTON Optional. A predefined constant or number.
The mouse button used to double-click the object.

Default value = micLeftBtn

Return Type

None

Example

                    'The following example uses the DblClick method to double-click a
'right mouse button at coordinates 73, 120 on "SysListView32"
'object.

VbWindow("frmMain").VbListView("SysListView32").DblClick 73, 120, 1

Back to top

 

Drag Method

Description

Performs the 'drag' part of a drag and drop operation.

Syntax

object.Drag X, Y, [BUTTON]

Arguments

ParameterDescription
X Required. An integer value.
The x-coordinate within the object from which the object is dragged. Note that the specified coordinates are relative to the upper left corner of the object.
Y Required. An integer value.
The y-coordinate within the object from which the object is dragged. Note that the specified coordinates are relative to the upper left corner of the object.
BUTTON Optional. A predefined constant or number.
The mouse button used to drag the object.
Default value = micLeftBtn

Return Type

None

Example

                    'The following example uses the Drag method to drag and drop an object in the
'InsertOrder frame.

VbWindow("frmMain").VbFrame("Insert Order").Drag 10, 20
VbWindow("frmMain").VbFrame("Insert Order").Drop 30, 40
                    'The following example uses the Drag method to drag the object
'from coordinates 10, 20 within the Test window and drop the object
'at coordinates 30, 40 within the OtherWindow window.

VbWindow("Test").Drag 10, 20
VbWindow("OtherWindow").Drop 30, 40

Back to top

 

DragItem Method

Description

Performs the 'drag' part of a drag and drop operation on a specified node in a tree-view control.

Syntax

object.DragItem (Item, [BUTTON])

Arguments

ParameterDescription
Item Required. A Variant.
The full path of the node to drag in the tree-view control. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 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") = "#"
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.

BUTTON Optional. A predefined constant or number.
The mouse button used to drag the node. 

Note: The same button must be used in both the DragItem and DropOnItem parts of the drag and drop operation.
Default value = micLeftBtn

Return Type

None.

IMPORTANT

A DragItem statement must be followed by a Drop or DropOnItem statement.

Example

                    'The following example uses the DragItem method to drag the item1 item
'in the tree and drop it at coordinates 10, 15.

Window("frmMain").VbTreeView("SysTreeView32").DragItem "item1"
Window("frmMain").VbTreeView("SysTreeView32").Drop 10, 15

Back to top

 

Drop Method

Description

Performs the 'drop' part of a drag and drop operation.

Syntax

object.Drop X, Y, [BUTTON]

Arguments

ParameterDescription
X Required. An integer value.
The x-coordinate of the object onto which the object is dropped. Note that the specified coordinates are relative to the upper left corner of the object.
Y Required. An integer value.
The y-coordinate of the object onto which the object is dropped. Note that the specified coordinates are relative to the upper left corner of the object.
BUTTON Optional. A predefined constant or number.
The mouse button that is released to drop the object.
Default value = micLeftBtn

Return Type

None

Example

                    'The following example uses the Drop method to drag and drop the
'InsertOrder frame.

VbWindow("frmMain").VbFrame("Insert Order").Drag 10, 20
VbWindow("frmMain").VbFrame("Insert Order").Drop 30, 40
                    'The following example uses the Drop method to drag the object
'from coordinates 10, 20 within the Test window and drop the
'object at coordinates 30, 40 within the OtherWindow.

VbWindow("Test").Drag 10, 20
VbWindow("OtherWindow").Drop 30, 40

Back to top

 

DropOnItem Method

Description

Completes the drag and drop operation by dropping the node onto a specified target node.

Syntax

object.DropOnItem (TargetItem, [BUTTON])

Arguments

ParameterDescription
TargetItem Required. A Variant.
The full path of the node on which to drop the dragged node. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 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") = "#"
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.

BUTTON Optional. A predefined constant or number.
The mouse button used to drop the node. 

Note: The same button must be used in both the DragItem and DropOnItem parts of the drag and drop operation.
Default value = micLeftBtn

Return Type

None.

IMPORTANT

A DropOnItem statement must be preceded by a Drag or DragItem statement.

Example

                    'The following example uses the DropOnItem method to drag the item
''located at coordinates 55, 11 in the tree and drop the item onto
'item32 within the tree.

Window("frmMain").VbTreeView("SysTreeView32").Drag 55, 11
Window("frmMain").VbTreeView("SysTreeView32").DropOnItem "item32"

Back to top

 

EditLabel Method

Description

Activates the edit mode for a node in the tree-view control in preparation for changing the node�s name.

Syntax

object.EditLabel Item

Arguments

ParameterDescription
Item Required. A Variant.

The full path of the node containing the label you want to edit. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 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") = "#"
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.

Return Type

None

IMPORTANT

This method only enables the node for renaming. To actually rename the node, you must set its value using the WinEdit or WinEditor test object, together with an applicable method, such as Set or SetCaretPos+Type.

Example

                    'The following example uses the EditLabel method to activate the edit
'mode for the "Desktop;My Documents;My Music" node. The example
'then uses the Set method to change the name of the node to
'"My Shared Music".

Window("frmMain").VbTreeView("SysTreeView32").Select "Desktop;My Documents;My Music"
Window("frmMain").VbTreeView("SysTreeView32").EditLabel "Desktop;My Documents;My Music"
Window("frmMain").VbTreeView("SysTreeView32").Set "My Shared Music"

Back to top

 

Expand Method

Description

Displays hidden sub-nodes of the specified node in a tree-view control.

Syntax

object.Expand Item

Arguments

ParameterDescription
Item Required. A Variant.
The full path of the node to expand in the tree-view control. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 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") = "#"
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.

Return Type

None

Example

                    'The following example uses the Expand method to expand the "Ins" node.

Window("frmMain").VbTreeView("SysTreeView32").Expand "Ins"

Back to top

 

ExpandAll Method

Description

Expands the node in the tree-view control and all of the nodes below it.

Syntax

object.ExpandAll Item

Arguments

ParameterDescription
Item Required. A Variant.
The full path of the node to expand. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 0.

Return Type

None

Example

                    'The following example uses the ExpandAll method to expand all child
'items below the "Desktop;My Documents" node.

Window("frmMain").VbTreeView("SysTreeView32").ExpandAll "Desktop;My Documents"

Back to top

 

GetCheckMarks Method

Description

Retrieves the index value for each node marked as checked.

Syntax

object.GetCheckMarks

Return Type

A String value.

Example

                    'The following example uses the GetCheckMarks method so that the
'"checked" variable gets values of checked items from "SysTreeView".

Checked = Window("frmMain").VbTreeView("SysTreeView").GetCheckMarks

Back to top

 

GetContent Method

Description

Returns all of the nodes in the tree-view control.

Syntax

object.GetContent

Return Type

A String value.

The returned string contains all of the nodes in the tree-view control separated by VBScript line feed characters.

Example

                    'The following example uses the GetContent method to return the items
'in the "SysTreeView" Tree View.

Contents = Window("frmMain").VbTreeView("SysTreeView").GetContent

Back to top

 

GetItem Method

Description

Returns the value of the node specified by the index.

Syntax

object.GetItem (Item)

Arguments

ParameterDescription
Item Required. A Variant.

The full path of the node you want to retrieve in the tree-view control. The path is composed of the numeric index of the nodes (without quotes) separated by a semicolon. The first node in a tree-view control is numbered 0.

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

 

Return Type

A String value.

Example

                    'The following example uses the GetItem method to return the value
'of the second item in the tree.

itemVal = Window("frmMain").VbTreeView("SysTreeView").GetItem(1)

Back to top

 

GetItemProperty Method

Description

Returns a node property in a tree-view control.

Syntax

object.GetItemProperty (Item, Property)

Arguments

ParameterDescription
Item Required. A Variant.
The full path of the node whose property you want to retrieve. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 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") = "#"
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 is numbered 0.

Property Required. A String value.
The node property for which you want to retrieve a value. The following properties are supported:
Property Name
Description
checked
Indicates whether the tree-view control node's check box is selected (available only for nodes with check boxes).
Possible values:                                    
       True
       False
focused
Indicates whether the tree-view control has the focus in a multiple selection list box.
Possible values:        
       True
       False
selected
Indicates whether the tree-view control is selected.
Possible values:                                    
       True
       False
text
The text of the tree-view control, or "" (empty string) if the tree-view control does not contain any text.

Return Type

A Variant.

Back to top

 

GetItemsCount Method

Description

Returns the number of nodes in the tree-view control.

Syntax

object.GetItemsCount

Return Type

A long integer value.

Example

                    ''The following example uses the GetItemsCount method to return the
'number of items in the Tree View.

NumberOfItems = Window("frmMain").VbTreeView("SysTreeView").GetItemsCount

Back to top

 

GetSelection Method

Description

Returns all of the selected nodes in the tree-view control.

Syntax

object.GetSelection

Return Type

A String value.

The returned string contains all of the selected nodes in the tree-view control separated by VBScript line feed characters.

Example

                    'The following example uses the GetSelection method to return the
'selected items in the Tree View.

Window("frmMain").VbTreeView("SysTreeView").Select "bin"
Selection = Window("frmMain").VbTreeView("SysTreeView").GetSelection

Back to top

 

GetTextLocation Method

Description

Checks whether the specified text string is contained in the specified window area.

Syntax

object.GetTextLocation (TextToFind, Left, Top, Right, Bottom, [MatchWholeWordOnly])

Arguments

ParameterDescription
TextToFind Required. A String value.
The text string you want to locate.
Left Required. A Variant.
The left coordinate of the search area within the window or screen.
Top Required. A Variant.
The top coordinate of the search area within the window or screen.
Right Required. A Variant.
The right coordinate of the search area within the window or screen.
Bottom Required. A Variant.
The bottom coordinate of the search area within the window or screen.

Note: Set the Left, Top, Right, and Bottom coordinates to -1 to search for the text string within the object's entire window.
MatchWholeWordOnly Optional. A Boolean value.
If True, the method searches for occurrences that are whole words only and not part of a larger word. If False, the method does not restrict the results to occurrences that are whole words only.
Default value = True

Return Type

A Boolean value.

IMPORTANT

  • The text to capture must be visible in the application window when the step runs.
  • This method returns True only if the TextToFind argument value is found within a single line in the specified area. The text search restarts on each line of text. 
  • If the TextToFind argument value includes a space, then this method searches for that text as whole words, regardless of the value set in the MatchWholeWords argument. For example, if you search for "a b" and the text "bla bla" exists, the method will still return False. However, if the MatchWholeWords argument is set to False, then a search for "la" in an area where "bla bla" exists, would return True. 
  • If the text is found (return value = True) and if the Left, Top, Right, and Bottom arguments are supplied as variables, then the method also returns the exact coordinates of the specified text to the supplied arguments (the returned coordinates overwrite the supplied ones).
  • The results of this method may be different depending on the settings selected in the Text Recognition pane of the Options dialog box (Tools menu > Options item > GUI Testing tab > Text Recognition pane).
  • The results of this method may be different in different run sessions depending on the operating system version you are using, service packs you have installed, other installed toolkits, or the APIs used in your application. Therefore, when possible, it is highly recommended to use the GetROProperty Method to retrieve the value of the text (or equivalent) property from an object in your application instead of using the GetTextLocation method.
  • By default, when UFT One captures text for a text/text area checkpoint or output value step using the GetText, GetTextLocation, or GetVisibleText methods, it tries to retrieve the text directly from the object using a Windows API-based mechanism. If UFT One cannot capture the text this way (for example, because the text is part of a picture), it tries to capture the text using an OCR (optical character recognition) mechanism. For details about changing this behavior, see the Can QuickTest Professional Text Recognition behavior be modified Knowledgebase article (number KM202721).

Example

                    'The following example uses the GetTextLocation method to retrieve
'all of the text within the object.

l = -1
t = -1
r = -1
b = -1
result = VbWindow("frmMain").VbEdit("txtName").GetTextLocation("2002", l, t, r, b)
If result Then
 MsgBox "Text found. Coordinates:" & l & "," & t & "," & r & "," & b
End If

Back to top

 

GetVisibleText Method

Description

Returns the text from the specified area.

Syntax

object.GetVisibleText ([Left], [Top], [Right], [Bottom])

Arguments

ParameterDescription
Left Optional. A long integer value.
The left coordinate of the search area within the object's window.
Default value = -1
Top Optional. A long integer value.
The top coordinate of the search area within the object's window.
Default value = -1
Right Optional. A long integer value.
The right coordinate of the search area within the object's window.
Default value = -1
Bottom Optional. A long integer value.
The bottom coordinate of the search area within the object's window.

Note: If the Left, Top, Right, and Bottom arguments are not specified, the method returns all of the text within the visible part of the specified object.
Default value = -1

Return Type

A String value.

The method returns the retrieved text, if any.  Additionally, if text is found, the exact coordinates of the text are returned to the Left, Top, Right, and Bottom arguments.

IMPORTANT

  • The text to capture must be visible in the application window when the step runs.
  • The area is defined by pairs of coordinates that designate two diagonally opposite corners of a rectangle.
  • The results of this method may be different depending on the settings selected in the Text Recognition pane of the Options dialog box (Tools menu > Options item > GUI Testing tab > Text Recognition pane).
  • The results of this method may be different in different run sessions depending on the operating system version you are using, service packs you have installed, other installed toolkits, or the APIs used in your application. Therefore, when possible, it is highly recommended to use the GetROProperty Method to retrieve the value of the text (or equivalent) property from an object in your application instead of using the GetVisibleText method.
  • By default, when UFT One captures text for a text/text area checkpoint or output value step using the GetText, GetTextLocation, or GetVisibleText methods, it tries to retrieve the text directly from the object using a Windows API-based mechanism. If UFT One cannot capture the text this way (for example, because the text is part of a picture), it tries to capture the text using an OCR (optical character recognition) mechanism. For details about changing this behavior, see the Can QuickTest Professional Text Recognition behavior be modified Knowledgebase article (number KM202721).

Example

                    'The following example uses the GetVisibleText method to retrieve
'the text from the "Test" window. If the returned string contains
'the "login:" sub-string, the Type method is used to type the
'"guest" string in the window.

TestText = VbWindow("Test").GetVisibleText
If InStr(1, TestText, "login:", 1) > 0 Then
VbWindow("Test").Type "guest"
End If
                    'The following example uses the GetVisibleText method to retrieve
'the text within the specified coordinates. If the returned string
'is not "Catalog", the ReportEvent method is used to report a
'failed step.

theText = VbWindow("frmMain").VbLabel("Name").GetVisibleText(16, 25, 56, 92)
If theText <> "Catalog" Then
 Reporter.ReportEvent micFail, "Traders", "Text check failed"
End If

Back to top

 

MouseMove Method

Description

Moves the mouse pointer to the designated position inside the window.

Syntax

object.MouseMove X, Y

Arguments

ParameterDescription
X Required. An integer value.
The position of the mouse pointer, expressed as an x (pixel) coordinate. Note that the specified coordinates are relative to the upper left corner of the object.
Y Required. An integer value.
The position of the mouse pointer, expressed as a y (pixel) coordinate. Note that the specified coordinates are relative to the upper left corner of the object.

Return Type

None

Example

                    'The following example uses the MouseMove method to move the mouse
'pointer to the position (20, 30) inside the "Insert Order" button.

VbWindow("frmMain").VbButton("Insert Order").MouseMove 20, 30

Back to top

 

Select Method

Description

Selects a node from the tree-view control.

Syntax

object.Select Item, [BUTTON], [Offset]

Arguments

ParameterDescription
Item Required. A Variant.
The full path of the node to select in the tree-view control. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 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") = "#"
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.

BUTTON Optional. A predefined constant or number.
The mouse button used to select the node.
Default value = micLeftBtn
Offset Optional. An integer value.
The horizontal offset (in pixels) of the click location relative to the left margin of the node's text. This argument can be used only if the BUTTON argument is defined. The default value is the center of the object.  
Default value = -1

Return Type

None

Example

                    'The following example uses the Select method to select the node with
'the right mouse button, with an offset of 20 pixels:

Window("frmMain").VbTreeView("SysTreeView32").Select "Green", 1, 20

Back to top

 

SetItemState Method

Description

Sets the state of a check box icon of the specified node in a tree-view control.

Syntax

object.SetItemState Item, State

Arguments

ParameterDescription
Item Required. A Variant.
The full path of the node whose check box you want to set. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 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") = "#"
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.

State Required. An integer value.
The state you want to set. The state can either be an index, or one of the following state constants:

micChecked (1)--Selects the node's check box
micUnchecked (0)--Clears the node's check  box 
micClick (-1)--Clicks the node icon
micDblClick (-2)--Double-clicks the node icon

Return Type

None

Example

                    'The following example uses the SetItemState method to clear the
'check box icon of the "Child" item in the tree view.

Window("frmMain").VbTreeView("SysTreeView32").SetItemState "Root1;Child", micUnchecked

Back to top

 

Type Method

Description

Types the specified string in the window.

Syntax

object.Type KeyboardInput

Arguments

ParameterDescription
KeyboardInput Required. A String value.
The text string and/or constants representing non-alphanumeric keys. The following constants are available:
Constant
Action
micCtrlDwn
Presses the Ctrl key.
micCtrlUp
Releases the Ctrl key.
micLCtrlDwn
Presses the left Ctrl key.
micLCtrlUp
Releases the left Ctrl key.
micRCtrlDwn
Presses the right Ctrl key.
micRCtrlUp
Releases the right Ctrl key.
micAltDwn
Presses the Alt key.
micAltUp
Releases the Alt key.
micLAltDwn
Presses the left Alt key.
micLAltUp
Releases the left Alt key.
micRAltDwn
Presses the right Alt key.
micRAltUp
Releases the right Alt key.
micShiftDwn
Presses the Shift key.
micShiftUp
Releases the Shift key.
micLShiftDwn
Presses the left Shift key.
micLShiftUp
Releases the left Shift key.
micRShiftDwn
Presses the right Shift key.
micRShiftUp
Releases the right Shift key.
micIns
Presses the Insert key.
micDel
Presses the Delete key.
micHome
Presses the Home key.
micEnd
Presses the End key.
micPgUp
Presses the Page Up key.
micPgDwn
Presses the Page Down key.
micUp
Presses the Up arrow key.
micDwn
Presses the Down arrow key.
micLeft
Presses the Left arrow key.
micRight
Presses the Right arrow key.
micEsc
Presses the Esc key.
micBack
Presses the Backspace key.
micReturn
Presses the Return key.
micTab
Presses the Tab key.
micBreak
Presses the Break key.
micPause
Presses the Pause key.
micPrintScr
Presses the Print Screen key.
micWinLogoDwn
Presses the Windows Logo key.
micWinLogoUp
Releases the Windows Logo key.
micLWinLogoDwn
Presses the left Windows Logo key.
micLWinLogoUp
Releases the left Windows Logo key.
micRWinLogoDwn
Presses the right Windows Logo key.
micRWinLogoUp
Releases the right Windows Logo key.
micAppKey
Presses the Application key.
micF1
Presses the F1 key.
micF2
Presses the F2 key.
micF3
Presses the F3 key.
micF4
Presses the F4 key.
micF5
Presses the F5 key.
micF6
Presses the F6 key.
micF7
Presses the F7 key.
micF8
Presses the F8 key.
micF9
Presses the F9 key.
micF10
Presses the F10 key.
micF11
Presses the F11 key.
micF12
Presses the F12 key.
micNumLockOn
Turns on the Num Lock.
micCapsLockOn
Turns on the Caps Lock.
micScrollOn
Turns on the Scroll Lock.
micNumLockOff
Turns off the Num Lock.
micCapsLockOff
Turns off the Caps Lock.
micScrollOff
Turns off the Scroll Lock.

Return Type

None

IMPORTANT

Although the Type method is supported for most objects, if you enter a Type statement for an object in which a user cannot enter text, the method has no visual effect.

Example

                    'The following example uses the Type method to press the "OK" button
'by pressing the "Enter" key.
VbWindow("frmLogin").VbButton("OK").Type micReturn

Back to top

 

WaitItemProperty Method

Description

Waits until the specified item property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Syntax

object.WaitItemProperty (Item, PropertyName, PropertyValue, [TimeOut])

Arguments

ParameterDescription
Item Required. A Variant.
The item name (with quotes) or numeric index (without quotes) can denote the item. The first item in a list is numbered 0.
PropertyName Required. A String value.
The name of the item property whose value is checked. The following properties are supported:
Property Name
Description
checked
Indicates whether the tree-view control node's check box is selected (available only for nodes with check boxes).
Possible values:                                    
       True
       False
focused
Indicates whether the tree-view control has the focus in a multiple selection list box.
Possible values:        
       True
       False
selected
Indicates whether the tree-view control is selected.
Possible values:                                    
       True
       False
text
The text of the tree-view control, or "" (empty string) if the tree-view control does not contain any text.
PropertyValue Required. A Variant.
The expected value against which the actual item property value should be checked. You can either use a simple value or you can use a comparison object together with the value to perform more complex comparisons.
TimeOut Optional. A long integer value.
The time, in milliseconds, after which UFT One continues to the next step if the specified item value is not achieved. If no value is specified, UFT One uses the time set in the Object Synchronization Timeout option in the Run pane of the Test Settings dialog box.
Default value = -1

Return Type

A Boolean value.

Returns TRUE if the item property achieves the value, and FALSE if the timeout is reached before the item property achieves the value. A FALSE return value does not indicate a failed step.

IMPORTANT

Tip: This method is useful for test run synchronization. Unlike the Exist method and the WaitProperty method, the WaitItemProperty method enables you to synchronize the test run based on a specific object item property. For example, you can instruct UFT One to wait for a particular string to appear in the second panel of the "StatusBar" control:
' Wait up to 30 seconds for the string "Ready" to appear in the second panel of the "StatusBar" control.
Window("Test").WinStatusBar("StatusBar").WaitItemProperty 2, "text", "Ready", 30000

You can also use comparison objects to perform more complex value comparisons. For example, you can instruct UFT One to wait until a specific item property value is greater than the specified value.

An example of the syntax required when using a comparison object is: Object.WaitItemProperty 2, "text", micNotEqual("John")"

The following comparison objects can be used:

  • micGreaterThan: Greater than; Specifies that UFT One waits until the item property value is greater than the specified value.
  • micLessThan: Less than; Specifies that UFT One waits until the item property value is less than the specified value.
  • micGreaterThanOrEqual: Greater than or equal to; Specifies that UFT One waits until the item property value is greater than or equal to the specified value.
  • micLessThanOrEqual: Less than or equal to; Specifies that UFT One waits until the item property value is less than or equal to the specified value.
  • micNotEqual: Not equal to; Specifies that UFT One waits until the item property value is not equal to the specified value.
  • micRegExpMatch: Regular expression; Specifies that UFT One waits until the item property value achieves a regular expression match with the specified value. Regular expressions are case-sensitive and must match exactly. For example, 'E.*h' matches 'Earth' but not 'The Earth' or 'earth'.

When the types of the expected value and actual value do not match, the comparisons are performed as follows (in this order):

  • Empty values: Empty values may be an uninitialized variable or field (which returns TRUE for the IsNull function in VBscript) or initialized to an empty value (which returns TRUE for the IsEmpty function is VBscript). When trying to compare two arguments when at least one is an empty value, the comparison assumes equality for two uninitialized arguments and for two empty arguments. Any other combination is considered unequal.
    For example:
    dim vEmpty
    Object.WaitItemProperty 2, "text",micNotEqual    (vEmpty) 
    will not wait for the timeout (because the 'text' property value is an empty string and the argument passed to micNotEqual is an empty value, and so micNotEqual finds them not equal and returns TRUE).
  • String values: When trying to compare a string value with non-string value, the string value is converted to the non-string type and then compared. If the string value cannot be converted to the non-string type, the comparison assumes the values are not equal.
    For example:
    Object.WaitItemProperty 2, "text",micGreaterThan(8) will not wait for the timeout if the 'text' property value is '16' (because micGreaterThan finds 16 to be greater than 8 and returns TRUE), but will wait if the 'text' property value is 'a' (because 'a' cannot be converted to a number).
  • Boolean values: When trying to compare a Boolean value with non-boolean value, the non-boolean value is converted to a boolean value and then compared. The conversion method assumes that any integer value other than '0' is TRUE, and that '0' alone is FALSE. If the conversion fails to produce a boolean value (for example, if the value is 'abc'), the comparison result will be FALSE (note that for the WaitProperty method this result would instruct UFT One to keep waiting). If the conversion succeeds, the method compares the two boolean values according to the comparison logic.
  • Other value types: When other value types do not match, they are compared under the assumption that different types are not equal (nor greater than or less than each other).

Back to top

See also: