WinListView Object

Description

A Windows list-view control.

IMPORTANT

  • You can check both the content and properties of a WinListView object. For example, you can check that a specified value is displayed in a certain cell. You can also check that the object has the expected number of rows and columns.
    When you insert a standard checkpoint on a WinListView object, the Define Row Range dialog box opens, enabling you to select the range of rows you want to include in your checkpoint. After you define the row range, the Table Checkpoint Properties dialog box opens, enabling you to check the content and properties of your WinListView object (instead of just the properties, as in standard checkpoints).
  • This test object is not supported for Qt applications.

Operations

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

Note: You can also view a list and descriptions of the WinListView 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) the specified item in the object's list.
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 an object.
Method ColumnCountReturns the number of columns in the list-view object.
Method DblClickDouble-clicks an object.
Method DeselectDeselects an item in the list.
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 the list's label to enable renaming.
Method ExtendSelectSelects an additional item from the multi-selection list.
Method GetCheckMarksRetrieves the number and the value of items marked as checked.
Method GetColumnHeaderReturns the text header of the specified (report-style) list-view column.
Method GetContentReturns a string containing all of the items in the list.
Method GetItemReturns the value of the item specified by the index.
Method GetItemPropertyReturns the current value of the specified property for the specified item in the list.
Method GetItemsCountReturns the number of items in the list.
Common Method GetROPropertyReturns the current value of the description property from the object in the application.
Method GetSelectionReturns all of the selected items in the list.
Method GetSubItemReturns the text value of the report-style (LVS_REPORT) list-view subitem.
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 an item from the list.
Method SelectRangeSelects all list items between (and including) the two specified items.
Method SetItemStateSets the state of the check box icon of the specified item in the list.
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) the specified item in the object's list.

Syntax

object.Activate Item, [BUTTON]

Arguments

ParameterDescription
Item Required. A Variant.
The item to select from the list-view control. The item value (with quotes) or numeric index (without quotes) can denote the item. The first item in a list-view control is numbered 0.
BUTTON Optional. A predefined constant or number.
The mouse button used to activate the list-view control.
Default value = micLeftBtn

Return Type

None

Example

                    'The following example uses the Activate method to double-click on the
'Drinks item in the SysListView32 list.

With Window("WinBurger")
    .Dialog("Food Inventory").WinListView("SysListView32").Activate "Drinks"
End With

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 list-view control item has the focus in a multiple selection list box.
Possible values:        
       True
       False
selected
Indicates whether the list-view control item is selected.
Possible values:                                    
       True
       False
state
The list-view control item's state image index, if defined.
text
The text of the list-view control item, or "" if the list-view control item 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 check
'whether the "John Doe" item of the "Names" list view is selected.
'If the expected value is not reached within two seconds, the step status
'is reported as Failed and the method returns False.

bSucceeded = Dialog("Select Name").WinList("Names").CheckItemProperty("John Doe", "selected", True, 2000)
                    'The following example uses the CheckItemProperty method to check whether
'the first item of the "Names" list view is selected. If the expected value
'is not reached within five seconds, the step status is reported as Failed
'and the method returns False.

bSucceeded = Dialog("Select Name").WinList("Names").CheckItemProperty(0, "selected", True, 5000)

Back to top

 

Click Method

Description

Clicks an 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 uses the Click method to click a right mouse
'button at coordinates 47, 131 on the Internet Options dialog box.

Browser("Booking Site").Dialog("Internet Options").Click 47, 131, 1

Back to top

 

ColumnCount Method

Description

Returns the number of columns in the list-view object.

Syntax

object.ColumnCount

Return Type

A long integer value.

IMPORTANT

Only the visible columns are counted.

Example

                    'The following example uses the ColumnCount method to determine the
'number of columns in the SysListView32 ListView, and then retrieve
'information for each column in the list.

With Dialog("Windows Task").WinListView("SysListView32")
     cColumns = .ColumnCount()
     sReport = "QTPro status:" & vbCr
     For iColumn = 0 To cColumns - 1
         sReport = sReport & .GetColumnHeader(iColumn) & " = " & .GetSubItem("QTPro.exe", iColumn) & vbCr
     Next
     MsgBox sReport
End With

Back to top

 

DblClick Method

Description

Double-clicks an 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 DblClick method to double-click a right
'mouse button at coordinates 73, 120 on the SysListView32 object.

Window("Exploring").WinListView("SysListView32").DblClick 73, 120, 1

Back to top

 

Deselect Method

Description

Deselects an item in the list.

Syntax

object.Deselect Item

Arguments

ParameterDescription
Item Required. A Variant.
The item to select from the list-view control. The item value (with quotes) or numeric index (without quotes) can denote the item. The first item in a list-view control is numbered 0.

Return Type

None

Example

                    'The following example uses the Deselect method to deselect a selected
'item from the list view.

With Window("WinBurger")
    .Dialog("Food Inventory").WinListView("SysListView32").Deselect "Hamburgers"
End With

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 the object from
'coordinates 10, 20 within the Test window and drop the object at
'coordinates 30, 40 within the same window.

Window("Test").Drag 10, 20
Window("Test").Drop 30, 40
                    'The following example uses the Drag and Drop methods to drag the object from
'coordinates 10, 20 within the Test window and drops the object at
'coordinates 30, 40 within the OtherWindow window.

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

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 to drag. The logical name (with quotes) or numeric index (without quotes) can denote the item. The first item in a list-view control is numbered 0.
BUTTON Optional. A predefined constant or number.
The mouse button used to click the object.

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 item1 from the
'list view within the AUT window and drops the item at coordinates
'10, 15 within the AUT window.

Window("AUT").WinListView("WinListView").DragItem "item1"
Window("AUT").WinObject("Afx").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 Drag and Drop methods to drag the object from
'coordinates 10, 20 within the Test window and drop the object at
'coordinates 30, 40 within the same window.

Window("Test").Drag 10, 20
Window("Test").Drop 30, 40
                    'The following example uses the Drag and Drop methods to drag the object from
'coordinates 10, 20 within the Test window and drops the object at
'coordinates 30, 40 within the OtherWindow window.

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

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 item on which to drop the dragged item. The logical name (with quotes) or numeric index (without quotes) can denote the item. The first item in a list-view control is numbered 0.
BUTTON Optional. A predefined constant or number.
The mouse button used to click the object.

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 within the AUT window and drops the
'item onto item32 within the AUT window.

Window("AUT").WinObject("Afx").Drag 55, 11
Window("AUT").WinListView("WinListView").DropOnItem "item32"

Back to top

 

EditLabel Method

Description

Activates the edit mode for the list's label to enable renaming.

Syntax

object.EditLabel (Item)

Arguments

ParameterDescription
Item Required. A Variant.
The item to select from the list-view control. The item value (with quotes) or numeric index (without quotes) can denote the item. The first item in a list-view control is numbered 0.

Return Type

None.

IMPORTANT

This method only enables the item for renaming. To actually rename the item, 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 bookmark.htm item. The example then uses the Set method
'to change the name of the item to bookmark.htm.bak.

Window("My Computer").WinListView("SysListView32").Select "bookmark.htm"
Window("My Computer").WinListView("SysListView32").EditLabel "bookmark.htm"
Window("My Computer").WinEdit("Edit").Set "bookmark.htm.bak"

Back to top

 

ExtendSelect Method

Description

Selects an additional item from the multi-selection list.

Syntax

object.ExtendSelect Item

Arguments

ParameterDescription
Item Required. A Variant.
The item to select from the list. The item value (with quotes) or numeric index (without quotes) can denote the item. The first item in a list is numbered 0.

Return Type

None

Example

                    'The following example uses the ExtendSelect method to add the
'Hamburgers item to the list.

With Window("WinBurger")
    .Dialog("Food Inventory").WinListView("SysListView32").ExtendSelect "Hamburgers"
End With

Back to top

 

GetCheckMarks Method

Description

Retrieves the number and the value of items marked as checked.

Syntax

object.GetCheckMarks

Return Type

A String value.

IMPORTANT

You can use this method only for list-view controls with 1000 or fewer items.

Example

                    'The following example uses the GetCheckMarks method to make chks get
'values of checked items from SysListView32.

With Window("WinBurger")
    chks = .Dialog("Food Inventory").WinListView("SysListView32").GetCheckMarks

Back to top

 

GetColumnHeader Method

Description

Returns the text header of the specified (report-style) list-view column.

Syntax

object.GetColumnHeader (vColumn)

Arguments

ParameterDescription
vColumn Required. A Variant.
The number of the list column whose header text you want to retrieve. The first column in a list-view control is numbered 0.

Return Type

A String value.

IMPORTANT

The columns are numbered from left to right according to their currently displayed order.

Example

                    'The following example uses the GetColumnHeader method to retrieve text
'header information for each column in the SysListView32 ListView.

With Dialog("Windows Task").WinListView("SysListView32")
     cColumns = .ColumnCount()
     sReport = "QTPro status:" & vbCr
     For iColumn = 0 To cColumns - 1
         sReport = sReport & .GetColumnHeader(iColumn) & " = " & .GetSubItem("QTPro.exe", iColumn) & vbCr
     Next
     MsgBox sReport
End With

Back to top

 

GetContent Method

Description

Returns a string containing all of the items in the list.

Syntax

object.GetContent

Return Type

A String value.

The returned string contains all of the items in the list separated by VBScript line feed characters.

IMPORTANT

You can use this method only for list-view controls with 1000 or fewer items.

Example

                    'The following example uses the GetContent method to return the items
'in the SysListView32 list.

With Window("WinBurger")
    content = .Dialog("Food Inventory").WinListView("SysListView32").GetContent
End With

Back to top

 

GetItem Method

Description

Returns the value of the item specified by the index.

Syntax

object.GetItem (Item)

Arguments

ParameterDescription
Item Required. A Variant.
Numeric index of the item. Index values begin with 0.

Return Type

A String value.

Example

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

itemVal = Window("WinBurger").Dialog("Food Inventory").WinListView("SysListView32").GetItem(1)

Back to top

 

GetItemProperty Method

Description

Returns the current value of the specified property for the specified item in the list.

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 list-view control is numbered 0.
Property Required. A String value.
The list-view control property for which you want to retrieve a value. The following properties are supported:
Property Name
Description
focused
Indicates whether the list-view control item has the focus in a multiple selection list box.
Possible values:        
       True
       False
selected
Indicates whether the list-view control item is selected.
Possible values:                                    
       True
       False
state
The list-view control item's state image index, if defined.
text
The text of the list-view control item, or "" if the list-view control item does not contain any text.

Return Type

A Variant.

IMPORTANT

This method may not correctly return the text property value for WinListView test objects.

Workaround: Use the GetItem method to retrieve the text property value for this test object.

Example

                    'The following example uses the GetItemProperty method to select
'different options in the RowList Sample window, and then retrieve
'specific properties for each item in the list.

Window("RowList Sample").WinListView("SysListView32").SetItemState "Cyan", micChecked
Window("RowList Sample").WinListView("SysListView32").Select "Green"
Window("RowList Sample").WinListView("SysListView32").SelectRange "Blue"
cItems = Window("RowList Sample").WinListView("SysListView32").GetItemsCount
sReport = "WinListView Item Properties" & vbCr
For iItem = 0 To cItems - 1
    sReport = sReport & "Item " & iItem & vbTab
    sReport = sReport & "Selected " & Window("RowList Sample").WinListView("SysListView32").GetITemProperty(iItem, "Selected") & vbTab
    sReport = sReport & "Focused " & Window("RowList Sample").WinListView("SysListView32").GetITemProperty(iItem, "Focused") & vbTab
    sReport = sReport & "State " & Window("RowList Sample").WinListView("SysListView32").GetITemProperty(iItem, "State") & vbTab
    sReport = sReport & "OverlayImage " & Window("RowList Sample").WinListView("SysListView32").GetITemProperty(iItem, "OverlayImage") & vbTab
    sReport = sReport & vbCr
Next
Reporter.ReportEvent micDone, "WinListView Item Properties", sReport

Back to top

 

GetItemsCount Method

Description

Returns the number of items in the list.

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

With Window("WinBurger")
    cnt = .Dialog("Food Inventory").WinListView("SysListView32").GetItemsCount
End With

Back to top

 

GetSelection Method

Description

Returns all of the selected items in the list.

Syntax

object.GetSelection

Return Type

A String value.

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

Example

                    'The following example uses the GetSelection method to return the
'selected items in the SysListView32 list.

With Window("WinBurger")
    sel = .Dialog("Food Inventory").WinListView("SysListView32").GetSelection
End With

Back to top

 

GetSubItem Method

Description

Returns the text value of the report-style (LVS_REPORT) list-view subitem.

Syntax

object.GetSubItem (Item, [SubItem])

Arguments

ParameterDescription
Item Required. A Variant.
The name or index value of the list-view control item whose sub-item you want to retrieve.
SubItem Optional. A Variant.
The name or numeric index of the list-view control sub-item you want to retrieve. If no value is specified, the first sub-item (index = 0) is used.
Default value = 0

Return Type

A String value.

Example

                    'The following example uses the GetSubItem method to retrieve the
'Image Name, PID, CPU, CPU Time, and Mem Usage properties for the
'first five items in the Processes tab of the Windows Task Manager
''dialog box. It then retrieves the same properties for the QTPro.exe
'process, regardless of its position in the process list.
'All of the retrieved properties are written to the run results.

With Dialog("Windows Task").WinListView("SysListView32")
     For i = 0 To 5
             sSub = "Image Name"
             sReport = sReport + .GetSubItem(i, "Image Name") & vbTab
             sReport = sReport + .GetSubItem(i, "PID") & vbTab
             sReport = sReport + .GetSubItem(i, "CPU") & vbTab
             sReport = sReport + .GetSubItem(i, "CPU Time") & vbTab
             sReport = sReport + .GetSubItem(i, "Mem Usage")
             sReport = sReport + vbCr
        Next
         sReport = sReport + .GetSubItem("QTPro.exe", 0) & vbTab
         sReport = sReport + .GetSubItem("QTPro.exe", 1) & vbTab
         sReport = sReport + .GetSubItem("QTPro.exe", 2) & vbTab
         sReport = sReport + .GetSubItem("QTPro.exe", 3) & vbTab
         sReport = sReport + .GetSubItem("QTPro.exe", 4)
         sReport = sReport + vbCr
    End With
    Reporter.ReportEvent micDone, "Task Manager", sReport

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 node).
  • 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 = Dialog("Dialog").WinObject("Date").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 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 node).
  • 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 Telnet window. If the returned string contains the "login:"
'sub-string, the Type method is used to type the guest string in the
'window.

TelnetText = Window("Telnet").GetVisibleText
If InStr(1, TelnetText, "login:", 1) > 0 Then
  Window("Telnet").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 = Window("Traders").WinObject("UserControl").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 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 MouseMove method to move the mouse
'pointer to the position (20, 30) inside the Advanced object.

Browser("MyPage").Dialog("Settings").WinObject("Advanced").MouseMove 20, 30

Back to top

 

Select Method

Description

Selects an item from the list.

Syntax

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

Arguments

ParameterDescription
Item Required. A Variant.
The item to select from the list-view control. The item value (with quotes) or numeric index (without quotes) can denote the item. The first item in a list-view control is numbered 0.
BUTTON Optional. A predefined constant or number.
The mouse button used to click the object.
Default value = micLeftBtn
Offset Optional. An integer value.
The horizontal offset (in pixels) of the click location relative to the left margin of the item'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 item
'with the right mouse button, with an offset of 20 pixels:

Window("RowList Sample").WinListView("SysListView32").Select "Green", 1, 20

Back to top

 

SelectRange Method

Description

Selects all list items between (and including) the two specified items.

Syntax

object.SelectRange Item, [Item2]

Arguments

ParameterDescription
Item Required. A Variant.
One of the items in the range. If the Item2 argument is not specified, then the Item is one end of the range and the currently selected item is the other end of the range.  If the Item2 argument is specified, then Item is the first item in the range.
The item value (with quotes) or numeric index (without quotes) can denote the item. The first item in a list is numbered 0.
Item2 Optional. A Variant.
The last item of the range.
The item value (with quotes) or numeric index (without quotes) can denote the item. The first item in a list-view control is numbered 0.

Return Type

None

IMPORTANT

This method is applicable only to list-view controls that allow multiple selection.

Example

                    'The following example uses the SelectRange method to select all
'the items between the currently selected item and the Hamburgers item.

With Window("WinBurger")
    .Dialog("Food Inventory").WinListView("SysListView32").Select "Side Orders"
    .Dialog("Food Inventory").WinListView("SysListView32").SelectRange "Hamburgers"
End With

Back to top

 

SetItemState Method

Description

Sets the state of the check box icon of the specified item in the list.

Syntax

object.SetItemState Item, State

Arguments

ParameterDescription
Item Required. A Variant.
The item to select from the list-view control. The item value (with quotes) or numeric index (without quotes) can denote the item. The first item in a list-view control is numbered 0.
State Required. An integer value.

The object's state. The state can either be an index, or one of the following state constants:
micChecked (1)--Selects the item's check box
micUnchecked (0)--Clears the item's check box micClick (-1)--Clicks the state icon
micDblClick (-2)--Double-clicks state icon

Return Type

None

Example

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

Dialog("Search").WinListView("SysTreeView32").SetItemState "Root1;Child", micUnchecked
                    'The following example uses the SetItemState method to set the state
'icon of the Child item in the list view, that has more than two states.
Dialog("Search").WinListView("SysTreeView32").SetItemState "Root1;Child", 3
                    'The following example uses the SetItemState method to double-click
'the check box icon of the Child item in the list view.

Dialog("Search").WinListView("SysTreeView32").SetItemState "Root1;Child", micDblClick

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 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 click the "OK" button
'by pressing the ENTER key:

Browser("Untitled").Dialog("Properties").WinButton("OK").Type micReturn
                    'The following example uses the Type method to select the Internet
'Explorer check box by pressing the SPACE key.

Browser("Untitled").Dialog("Internet Options").WinCheckBox("Internet Explorer").Type " "

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 to wait for. The following properties are supported:
Property Name
Description
focused
Indicates whether the list-view control item has the focus in a multiple selection list box.
Possible values:        
       True
       False
selected
Indicates whether the list-view control item is selected.
Possible values:                                    
       True
       False
state
The list-view control item's state image index, if defined.
text
The text of the list-view control item, or "" if the list-view control item 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).

Example

                    'The following example uses the WaitItemProperty method to wait
'up to two seconds until the "John Doe" item of the "Names" list view
'is selected. If the expected value is not reached within two seconds,
'the method returns False and the step status is reported as Warning.

bSucceeded = Dialog("Select Name").WinList("Names").WaitItemProperty("John Doe", "selected", True, 2000)
                    'The following example uses the WaitItemProperty method to wait
'up to five seconds until the first item of the "Names" list view
'is selected. If the expected value is not reached within five seconds,
'the method returns False and the step status is reported as Warning.

bSucceeded = Dialog("Select Name").WinList("Names").WaitItemProperty(0, "selected", True, 5000)

Back to top

See also: