DelphiTreeView Object

Description

A Delphi tree-view control.

IMPORTANT

The DelphiTreeView object is learned for the following Delphi controls: TTreeView.

Operations

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

Note: You can also view a list and descriptions of the DelphiTreeView 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 object.
Method CollapseHides sub-nodes of the specified node in the expanded tree-view control.
Method DblClickDouble-clicks the object.
Method DragPerforms the 'drag' part of a drag and drop operation.
Method DragItemPerforms the 'drag' part of a drag and drop operation.
Method DropPerforms the 'drop' part of a drag and drop operation.
Method DropOnItemPerforms the 'drop' part of a drag and drop operation.
Method EditLabelActivates the edit mode for a node in the tree-view control to enable renaming.
Method ExpandDisplays hidden sub-nodes of the specified node in the 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 the current value of a property for a node in the 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 object.
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 in the tree-view control.
Method SetItemStateSets the state of the check box icon of the specified node in the tree-view control.
Method SetROPropertySets the value of the specified property of the object in the application.
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 object.
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.

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 item name (with quotes) or numeric index (without quotes) can denote the item. The first item in a tree-view control is numbered 0.
BUTTON Optional. A predefined constant or number.
The mouse button used to activate the tree-view control node.
Default value = micLeftBtn

Return Type

None

Example

                    'The following example uses the Activate method to verify that each
'item in the tree view is expanded.

   'Iterate over items
   itemsCount = treeViewTO.GetItemsCount
   For curIndex = 0 To itemsCount - 1
        'Verify that the current item is expanded
        curItemPath = treeViewTO.GetItemProperty(curIndex, "path")
        If curItemPath = itemPath Then
                treeViewTO.Activate curIndex
        End If
   Next

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 node in a tree 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
expanded 
Indicates whether the node is currently expanded.
Possible values:
True--node is currently expanded
False--node is currently collapsed
firstchild 
The full path of the node's first child node as a semi-colon delimited string.
haschildren 
Indicates whether the node has children.
Possible values:
True--node has children
False--node does not have children 
imageindex
The image index of the node. 
nextsibling
The full path of the node's next sibling node as a semi-colon delimited string.
overlayimage 
The index number of the current overlay image.
parent
The full path of the node's parent node as a semi-colon delimited string.
path 
The full path of the node as a semi-colon delimited string.
selected
Indicates whether the node 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 node, or "" if the node 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).

Example

                    'The following example uses the CheckItemProperty method to verify that each
'item in the tree view has children nodes, and if they do, verifies that they
'are expanded.

   'Iterate over items
   itemsCount = treeViewTO.GetItemsCount
   For curIndex = 0 To itemsCount - 1
        'Verify that the current item is expanded
        bIsParent = treeViewTO.GetItemProperty(curIndex, "haschildren")
        If bIsParent Then
                treeViewTO.CheckItemProperty curIndex, "expanded", True, 0
        End If
   Next

Back to top

 

Click Method

Description

Clicks the object.

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

                    'The following example sets the 'Accept' radio button to 'True'. Afterwards,
'the 'enabled' property of the 'Next' button is checked with the use of GetROProperty.
'If it is indeed enabled, it is clicked. Otherwise, an error is reported
'to the run results, and the 'Cancel' button is clicked.

    'Set the radio button
    DelphiWindow("Ex_Dialog").DelphiRadioButton("Accept").Set
    'Verify that the 'Next' button is enabled and click the enabled button
    bEnabled = DelphiWindow("Ex_Dialog").DelphiButton("Next").GetROProperty("enabled")
    If True = bEnabled Then
        DelphiWindow("Ex_Dialog").DelphiButton("Next").Click
    Else
       Reporter.ReportEvent micFail, "RadioButton_Set_and_Button_Click_Example", "'Next' button is not enabled even though 'Accept' radio button was set to 'True'"
       DelphiWindow("Ex_Dialog").DelphiButton("Cancel").Click
    End If

Back to top

 

Collapse Method

Description

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

Syntax

object.Collapse Item

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 tree-view control is numbered 0.

Return Type

None

Example

                    'The following example uses the Collapse method to collapse all the nodes in the tree view.
    
    itemsCount = treeViewTO.GetItemsCount
    curItem = 0
    While curItem < itemsCount
         treeViewTO.Collapse curItem
         newItemsCount = treeViewTO.GetItemsCount
         numRemovedItems = itemsCount - newItemsCount
         curItem = curItem + 1
         itemsCount = newItemsCount
    Wend

Back to top

 

DblClick Method

Description

Double-clicks the object.

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 GetTextLocatation method to locate a button which
'is not recognized as a separate object, and then double clicks it.

    'Find the text
    bFound = windowTO.GetTextLocation(iconLabel, left_x, top_y, right_x, bottom_y, True)
    If bFound = False Then
        DblClickUnrecognizedIcon = False
        Exit Function
    End If
    'Double click the center of the button
    center_x = right_x - left_x
    center_y = bottom_y - top_y
    windowTO.DblClick center_x, center_y
    'Set the return value
    DoubleClick_Example = True

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 window 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 window 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 and Drop methods to drag an item from its
'current location and drop it in a folder.

    'Find the coordinate of the item
    sourceListView.GetTextLocation itemLabel, source_left_x, source_top_y, source_right_x, source_bottom_y, True
    source_center_x = (source_right_x + source_left_x) / 2
    source_center_y = (source_bottom_y + source_top_y) / 2
    'Find the coordinates of the folder item in target listview
    targetListView.GetTextLocation folderLabel, target_left_x, target_top_y, target_right_x, target_bottom_y, True
    target_center_x = (target_right_x + target_left_x) / 2
    target_center_y = (target_bottom_y + target_top_y) / 2
    'Execute the drag and drop operation
     sourceListView.Drag source_center_x, source_center_y, micLeftBtn
     targetListView.Drop target_center_x, target_center_y, micLeftBtn

Back to top

 

DragItem Method

Description

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

Syntax

object.DragItem (Item, [BUTTON])

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 tree-view control is numbered 0.
BUTTON Optional. A predefined constant or number.
The mouse button used to click 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 GetItemProperty method to find the index of the
'specified folder. It then uses the GetItem method to retrieve the file name of
'each file and the Drag and Drop methods to move the files to the specified folder.

   'First expand the whole hierarchy
   ExpandWholeHierarchy (treeViewTO)
   'Find the index of the folder item
    itemsCount = treeViewTO.GetItemsCount
    folderIndex = -1
    For curItem = 0 To itemsCount - 1
        curFileName = treeViewTO.GetItemProperty(curItem, "text")
        If curFileName = folderName Then
            folderIndex = curItem
            Exit For
        End If
    Next
   'Iterate over all items and move dlls to folder
    itemsCount = treeViewTO.GetItemsCount
    For curItem = 0 To itemsCount - 1
        curFileName = treeViewTO.GetItem(curItem)
        If StrComp(".dll", Right(curFileName, 4)) = 0 Then
            treeViewTO.DragItem curItem, micLeftBtn
            treeViewTO.DropOnItem folderIndex, micLeftBtn
        End If
    Next

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 Drag and Drop methods to drag an item from its
'current location and drop it in a folder.

    'Find the coordinate of the item
    sourceListView.GetTextLocation itemLabel, source_left_x, source_top_y, source_right_x, source_bottom_y, True
    source_center_x = (source_right_x + source_left_x) / 2
    source_center_y = (source_bottom_y + source_top_y) / 2
    'Find the coordinates of the folder item in target listview
    targetListView.GetTextLocation folderLabel, target_left_x, target_top_y, target_right_x, target_bottom_y, True
    target_center_x = (target_right_x + target_left_x) / 2
    target_center_y = (target_bottom_y + target_top_y) / 2
    'Execute the drag and drop operation
     sourceListView.Drag source_center_x, source_center_y, micLeftBtn
     targetListView.Drop target_center_x, target_center_y, micLeftBtn

Back to top

 

DropOnItem Method

Description

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

Syntax

object.DropOnItem (TargetItem, [BUTTON])

Arguments

ParameterDescription
TargetItem Required. A Variant.
The target item name (with quotes) or numeric index (without quotes) can denote the item. The first item in a tree-view control is numbered 0.
BUTTON Optional. A predefined constant or number.
The mouse button used to click 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 GetItemProperty method to find the index of the
'specified folder. It then uses the GetItem method to retrieve the file name of
'each file and the Drag and Drop methods to move the files to the specified folder.

   'First expand the whole hierarchy
   ExpandWholeHierarchy (treeViewTO)
   'Find the index of the folder item
    itemsCount = treeViewTO.GetItemsCount
    folderIndex = -1
    For curItem = 0 To itemsCount - 1
        curFileName = treeViewTO.GetItemProperty(curItem, "text")
        If curFileName = folderName Then
            folderIndex = curItem
            Exit For
        End If
    Next
   'Iterate over all items and move dlls to folder
    itemsCount = treeViewTO.GetItemsCount
    For curItem = 0 To itemsCount - 1
        curFileName = treeViewTO.GetItem(curItem)
        If StrComp(".dll", Right(curFileName, 4)) = 0 Then
            treeViewTO.DragItem curItem, micLeftBtn
            treeViewTO.DropOnItem folderIndex, micLeftBtn
        End If
    Next

Back to top

 

EditLabel Method

Description

Activates the edit mode for a node in the tree-view control to enable renaming.

Syntax

object.EditLabel Item

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 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 DelphiEdit or DelphiEditor test object, together with an applicable method, such as Set or SetCaretPos+Type.

Example

                    'The following example uses the GetSelection method to retrieve the values
'in a tree view and then uses the EditLabel method to enable editing of their labels

   Selected = treeViewTO.GetSelection
   aSelected = Split(Selected, vbLf)
    'Iterate over the selected items
    For curArrayIndex = 0 To UBound(aSelected)
        'Enable the label for editing
        curItem = aSelected(curArrayIndex)
        treeViewTO.EditLabel curItem
    Next

Back to top

 

Expand Method

Description

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

Syntax

object.Expand Item

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 tree-view control is numbered 0.

Return Type

None

Example

                    'The following example uses the Expand method to expand all the nodes in the tree view.

    itemsCount = treeViewTO.GetItemsCount
    curItem = 0
    While curItem < itemsCount
         treeViewTO.Expand curItem
         curItem = curItem + 1
         itemsCount = treeViewTO.GetItemsCount
    Wend

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 item name (with quotes) or numeric index (without quotes) can denote the item. The first item in a tree-view control is numbered 0.

Return Type

None

Example

                    'The following example uses the ExpandAll method which operates on a single
'node in the tree, to expand the whole hierarchy.

    itemsCount = treeViewTO.GetItemsCount
    curItem = 0
    While curItem < itemsCount
         treeViewTO.ExpandAll curItem
         newItemsCount = treeViewTO.GetItemsCount
         numAddedItems = newItemsCount - itemsCount
         curItem = curItem + numAddedItems + 1
         itemsCount = newItemsCount
    Wend

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 unchecks any checked items in the treeview and
'verifies their state

      'iterate over treeview items, deselecting each
      itemsCount = treeViewTO.GetItemsCount
      curItem = 0
      While curItem < itemsCount
            'deselect curItem
            treeViewTO.SetItemState curItem, micUnchecked
            'expand subtree and update curItem
            treeViewTO.ExpandAll curItem
            newItemsCount = treeViewTO.GetItemsCount
            numAddedItems = newItemsCount - itemsCount
            curItem = curItem + numAddedItems + 1
            itemsCount = newItemsCount
      Wend
      'verify all items are not selected
      SetItemState_GetCheckMarks_Example = False
      checkedItems = treeViewTO.GetCheckMarks
      If checkedItems = "" Then
            SetItemState_GetCheckMarks_Example = True
      End If

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 determine
'whether the specified branch exists in the tree.
    
    'Expand the tree
     ExpandWholeHierarchy (treeViewTO)
     'Place all the items of the tree into an array
     content = treeViewTO.GetContent
     aContent = Split(content, vbLf)
     For arrIndex = 0 To UBound(aContent)
         curBranch = aContent(arrIndex)
         If curBranch = branch Then
             BranchExists = True
             Exit Function
        End If
     Next
     GetContent_Example = False

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 item name (with quotes) or numeric index (without quotes) can denote the item. The first item in a tree-view control is numbered 0.

Return Type

A String value.

Example

                    'The following example uses the GetItemProperty method to find the index of the
'specified folder. It then uses the GetItem method to retrieve the file name of
'each file and the Drag and Drop methods to move the files to the specified folder.

   'First expand the whole hierarchy
   ExpandWholeHierarchy (treeViewTO)
   'Find the index of the folder item
    itemsCount = treeViewTO.GetItemsCount
    folderIndex = -1
    For curItem = 0 To itemsCount - 1
        curFileName = treeViewTO.GetItemProperty(curItem, "text")
        If curFileName = folderName Then
            folderIndex = curItem
            Exit For
        End If
    Next
   'Iterate over all items and move dlls to folder
    itemsCount = treeViewTO.GetItemsCount
    For curItem = 0 To itemsCount - 1
        curFileName = treeViewTO.GetItem(curItem)
        If StrComp(".dll", Right(curFileName, 4)) = 0 Then
            treeViewTO.DragItem curItem, micLeftBtn
            treeViewTO.DropOnItem folderIndex, micLeftBtn
        End If
    Next

Back to top

 

GetItemProperty Method

Description

Returns the current value of a property for a node in the tree-view control.

Syntax

object.GetItemProperty (Item, Property)

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 tree-view control 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
expanded 
Indicates whether the node is currently expanded.
Possible values:
True--node is currently expanded
False--node is currently collapsed
firstchild 
The full path of the node's first child node as a semi-colon delimited string.
haschildren 
Indicates whether the node has children.
Possible values:
True--node has children
False--node does not have children 
imageindex
The image index of the node. 
nextsibling
The full path of the node's next sibling node as a semi-colon delimited string.
overlayimage 
The index number of the current overlay image.
parent
The full path of the node's parent node as a semi-colon delimited string.
path 
The full path of the node as a semi-colon delimited string.
selected
Indicates whether the node is selected.
Possible values:                                    
       True
       False
state
The state image index of the node.
text
The text of the node, or "" if the node does not contain any text.

 

Return Type

A Variant.

Example

                    'The following example uses the GetItemProperty method to find the index of the
'specified folder. It then uses the GetItem method to retrieve the file name of
'each file and the Drag and Drop methods to move the files to the specified folder.

   'First expand the whole hierarchy
   ExpandWholeHierarchy (treeViewTO)
   'Find the index of the folder item
    itemsCount = treeViewTO.GetItemsCount
    folderIndex = -1
    For curItem = 0 To itemsCount - 1
        curFileName = treeViewTO.GetItemProperty(curItem, "text")
        If curFileName = folderName Then
            folderIndex = curItem
            Exit For
        End If
    Next
   'Iterate over all items and move dlls to folder
    itemsCount = treeViewTO.GetItemsCount
    For curItem = 0 To itemsCount - 1
        curFileName = treeViewTO.GetItem(curItem)
        If StrComp(".dll", Right(curFileName, 4)) = 0 Then
            treeViewTO.DragItem curItem, micLeftBtn
            treeViewTO.DropOnItem folderIndex, micLeftBtn
        End If
    Next

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 ExpandAll method which operates on a single
'node in the tree, to expand the whole hierarchy.

    itemsCount = treeViewTO.GetItemsCount
    curItem = 0
    While curItem < itemsCount
         treeViewTO.ExpandAll curItem
         newItemsCount = treeViewTO.GetItemsCount
         numAddedItems = newItemsCount - itemsCount
         curItem = curItem + numAddedItems + 1
         itemsCount = newItemsCount
    Wend

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 retrieve the values
'in a tree view and then uses the EditLabel method to enable editing of their labels

   Selected = treeViewTO.GetSelection
   aSelected = Split(Selected, vbLf)
    'Iterate over the selected items
    For curArrayIndex = 0 To UBound(aSelected)
        'Enable the label for editing
        curItem = aSelected(curArrayIndex)
        treeViewTO.EditLabel curItem
    Next

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, as a long integer.
Top Required. A Variant.
The top coordinate of the search area within the window or screen, as a long integer.
Right Required. A Variant.
The right coordinate of the search area within the window or screen, as a long integer.
Bottom Required. A Variant.
The bottom coordinate of the search area within the window or screen, as a long integer.

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.

This method returns the coordinates of the rectangle containing the first instance of the text into the Left, Top, Right, and Bottom arguments if the text is found.

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 locate the text on a
'button that has not been implemented with a separate control. Once the button
'is located, it is clicked.

    'Find the text
    bFound = windowTO.GetTextLocation(buttonText, left_x, top_y, right_x, bottom_y, True)
    If bFound = False Then
        ClickUnrecognizedButton = False
        Exit Function
    End If
    'Click the center of the button
    center_x = right_x - left_x
    center_y = bottom_y - top_y
    windowTO.Click center_x, center_y
    'Set return value
    GetTextLocation_Example = True

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

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 determine if an error
'message has been displayed. If it has, the function returns 'True'.

    allText = windowTO.GetVisibleText
    If InStr(allText, "Error") <> 0 Then
        NoError = False
        Exit Function
    End If
	    GetVisibleText_Example = True

Back to top

 

MouseMove Method

Description

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

Syntax

object.MouseMove X, Y

Arguments

ParameterDescription
X Required. An integer value.
The x-coordinate of the mouse pointer, relative to the upper left corner of the object.
Y Required. An integer value.
The y-coordinate of the mouse pointer, relative to the upper left corner of the object.

Return Type

None

Example

                    'The following example uses the Check method to verify that a tooltip
'is displayed when the mouse hovers over an object.

   windowTO.MouseMove x, y
   windowTO.Check bitmapCheckpoint

Back to top

 

Select Method

Description

Selects a node in the tree-view control.

Syntax

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

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 tree-view control is numbered 0.
BUTTON Optional. A predefined constant or number.
The mouse button used to click 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 WaitItemProperty to determine if the specified
'item in the tree view is selected. It then uses the Select method to
'select it, if it is not selected.

   'Iterate over items
   itemsCount = treeViewTO.GetItemsCount
   For curIndex = 0 To itemsCount
        'Check if this is the specified item
        curItem = treeViewTO.GetItem(curIndex)
       If curItem = itemName Then
           'If it is not selected, execute Select
           bIsSelected = treeViewTO.WaitItemProperty(curIndex, "selected", True, 0)
           If bIsSelected = False Then
               treeViewTO.Select curIndex
           End If
           'Exit if the specified item is found.
           Exit Sub
       End If
   Next

Back to top

 

SetItemState Method

Description

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

Syntax

object.SetItemState Item, State

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 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 unchecks any checked items in the treeview and
'verifies their state

      'iterate over treeview items, deselecting each
      itemsCount = treeViewTO.GetItemsCount
      curItem = 0
      While curItem < itemsCount
            'deselect curItem
            treeViewTO.SetItemState curItem, micUnchecked
            'expand subtree and update curItem
            treeViewTO.ExpandAll curItem
            newItemsCount = treeViewTO.GetItemsCount
            numAddedItems = newItemsCount - itemsCount
            curItem = curItem + numAddedItems + 1
            itemsCount = newItemsCount
      Wend
      'verify all items are not selected
      SetItemState_GetCheckMarks_Example = False
      checkedItems = treeViewTO.GetCheckMarks
      If checkedItems = "" Then
            SetItemState_GetCheckMarks_Example = True
      End If

Back to top

 

SetROProperty Method

Description

Sets the value of the specified property of the object in the application.

Syntax

object.SetROProperty PropertyName, PropertyValue

Arguments

ParameterDescription
PropertyName Required. A String value.
The name of the property you want to set.  You can specify any test object description properties supported for the object, or any property of the run-time Delphi object.
PropertyValue Required. A Variant.
The value to set.

Return Type

None

Example

                    'The following example uses the SetROProperty to move the scroll bar
'to the specified position.

        scrollBarTO.SetROProperty "position", pos

Back to top

 

Type Method

Description

Types the specified string in the object.

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 windown key.
micUp
Presses the Up arrow key.
micDwn
Presses the windown 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 SetSelection method to replace the word "sad"
'with the word "happy". It then uses the SetCaretPos method to place the cursor at
'the eighth character position in the "Edit1" window, and type the word "very".

    DelphiWindow("Form1").DelphiEditor("RichEdit1").Type "I am happy." + micReturn
    DelphiWindow("Form1").DelphiEditor("RichEdit1").Type "You are sad." + micReturn
    DelphiWindow("Form1").DelphiEditor("RichEdit1").SetSelection 1, 8, 1, 11
    DelphiWindow("Form1").DelphiEditor("RichEdit1").Type "happy"
    DelphiWindow("Form1").DelphiEditor("RichEdit1").SetCaretPos 1, 8
    DelphiWindow("Form1").DelphiEditor("RichEdit1").Type "very "

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 node in a tree is numbered 0.
PropertyName Required. A String value.

The name of the item property whose value to wait for. The following properties are supported:

Property Name
Description
expanded 
Indicates whether the node is currently expanded.
Possible values:
True--node is currently expanded
False--node is currently collapsed
firstchild 
The full path of the node's first child node as a semi-colon delimited string.
haschildren 
Indicates whether the node has children.
Possible values:
True--node has children
False--node does not have children 
imageindex
The image index of the node. 
nextsibling
The full path of the node's next sibling node as a semi-colon delimited string.
overlayimage 
The index number of the current overlay image.
parent
The full path of the node's parent node as a semi-colon delimited string.
path 
The full path of the node as a semi-colon delimited string.
selected
Indicates whether the node 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 node, or "" if the node 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.
DelphiWindow("Test").DelphiStatusBar("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).

Example

                    'The following example uses the WaitItemProperty to determine if the specified
'item in the tree view is selected. It then uses the Select method to
'select it, if it is not selected.

   'Iterate over items
   itemsCount = treeViewTO.GetItemsCount
   For curIndex = 0 To itemsCount
        'Check if this is the specified item
        curItem = treeViewTO.GetItem(curIndex)
       If curItem = itemName Then
           'If it is not selected, execute Select
           bIsSelected = treeViewTO.WaitItemProperty(curIndex, "selected", True, 0)
           If bIsSelected = False Then
               treeViewTO.Select curIndex
           End If
           'Exit if the specified item is found.
           Exit Sub
       End If
   Next

Back to top

See also: