Syntax

Arguments

Required. A Variant.
The left coordinate of the search area within the window or screen.

Top

Required. A Variant.
The top coordinate of the search area within the window or screen.

Right

Required. A Variant.
The right coordinate of the search area within the window or screen.

Bottom

Required. A Variant.
The bottom coordinate of the search area within the window or screen.

Note: Set the Left, Top, Right, and Bottom coordinates to -1 to search for the text string within the object's entire window.

MatchWholeWordOnly

Optional. A Boolean value.
If True, the method searches for occurrences that are whole words only and not part of a larger word. If False, the method does not restrict the results to occurrences that are whole words only. Default value = TrueDefault value = True

Return Type

A Boolean value.

IMPORTANT

The text to capture must be visible in the application window when the step runs.

This method returns True only if the 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, the APIs used in your application, and so on. 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 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 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).

GetVisibleText Method

Description

Syntax

Arguments

Optional. A long integer value.
The left coordinate of the search area within the object's window.Default value = -1

Top

Optional. A long integer value.
The top coordinate of the search area within the object's window.Default value = -1

Right

Optional. A long integer value.
The right coordinate of the search area within the object's window.Default value = -1

Bottom

Optional. A long integer value.
The bottom coordinate of the search area within the object's window.

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

Return Type

A String value.

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

IMPORTANT

The text to capture must be visible in the application window when the step runs.

The area is defined by pairs of coordinates that designate two diagonally opposite corners of a rectangle.

The results of this method may be different depending on the settings selected in the Text Recognition pane of the Options dialog box (Tools menu > Options item > GUI Testing tab > Text Recognition pane).

The results of this method may be different in different run sessions depending on the operating system version you are using, service packs you have installed, other installed toolkits, the APIs used in your application, and so on. 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 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 cannot capture the text this way (for example, because the text is part of a picture), it tries to capture the text using an OCR (optical character recognition) mechanism. For details about changing this behavior, see the Can QuickTest Professional Text Recognition behavior be modified Knowledgebase article (number KM202721).

Example

'The following example uses the GetVisibleText method to retrieve
'the text from the "Test" window. If the returned string contains
'the "login:" sub-string, the Type method is used to type the
'"guest" string in the window.
TestText = VbWindow("Test").GetVisibleText
IfInStr(1, TestText, "login:", 1) > 0 Then
VbWindow("Test").Type "guest"EndIf

Return Type

Example

'The following example uses the SetCaretPos method to type a sentence
'at the beginning of the third line of the "txtName" editor.
VbWindow("frmMain").VbEditor("txtName").SetCaretPos 3, 0
VbWindow("frmMain").VbEditor("txtName").Type "This text will be inserted at the beginning of the line 3"

Return Type

Example

'The following example uses the SetSelection method to select text from
'the beginning of line 3 through column 16 of line four, and then
'presses the "Delete" key to delete the selected text.
VbWindow("frmMain").VbEditor("txtName").SetSelection 3, 0, 4, 16
VbWindow("frmMain").VbEditor("txtName").Type micDel