AITextObject Object
UFT One AI-based testing support:
UFT One version | Mobile apps | Desktop web |
---|---|---|
15.0 | Supported | Not supported |
15.0.1 | Supported | Technical preview |
15.0.2 | Supported | Supported |
Description
An internal object used to perform operations on text identified by AI in the application.
IMPORTANT
AI objects are supported in UFT One only when:
- The UFT One Web Add-in or Mobile Add-in are installed and loaded.
- The UFT One AI Features are installed and AI is enabled in the UFT One options. For details, see the UFT One Help Center.
To retrieve an AITextObject object, use the AIUtil.FindText or AIUtil.FindTextBlock property.
Operations
The sections below list the built-in methods and properties that you can use as operations for the AITextObject object.
Methods
CheckExists ** | A checkpoint that checks whether the object currently exists in the set context. |
Click | Clicks the text. |
GetText ** | Retrieves the object’s text. |
Highlight | Highlights the text in the application. |
Hover * | Holds the cursor over the text. |
Type ** | Types the specified string in an input or edit box identified as text. |
TypeSecure ** | Types the specified encrypted string in an input or edit box identified as text. |
* Supported in UFT One versions 15.0.1 and later.
** Supported in UFT One versions 15.0.2 and later.
Properties
Exist | Checks whether the object currently exists in the set context. |
CheckExists Method
Supported in UFT One versions 15.0.2 and later.
Description
A checkpoint that checks whether the object currently exists in the set context.
Syntax
AIUtil.FindText(text, [locator], [locatorData]).CheckExists expected
Arguments
Parameter | Description |
---|---|
expected | A Boolean value. Specifies whether this checkpoint expects the object to exist. Possible values: true. The checkpoint passes if the object is found within the set context before the timeout expires. false. The checkpoint passes if the object is not found by the time the timeout expires. |
Remarks
This method uses the timeout defined 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 checkpoint passes, otherwise FALSE.
A TRUE return value reports a Passed step to the run results; a FALSE return value reports a Failed step to the run results.
Example
'The following example checks for the "New version available" text in the application AIUtil.SetContext Device("device") 'Set the context for AI AIUtil.FindText("New version available").CheckExists true
Click Method
Description
Clicks the text.
Syntax
AIUtil.FindText(text, [locator], [locatorData]).Click [x], [y]
Arguments
Parameter | Description |
---|---|
x |
Optional. An integer value. The x-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the middle of the object (-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 middle of the object (-9999). |
Return Type
None
Example
'The following example clicks on the user name and login texts on the screen AIUtil.SetContext Device("device") 'Set the context for AI AIUtil.FindText("User Name").Click AIUtil.FindText("LogIn").Click 10, 10 'Click the 10,10 point in the LogIn text
GetText Method
Supported in UFT One versions 15.0.2 and later.
Description
Retrieves the object’s text.
Syntax
AIUtil.FindText(text, [locator], [locatorData]).GetText
Return Type
String
Example
'The following example prints the price displayed to the right of the Total Price label AIUtil.SetContext Device("device") 'Set the context for AI Set anchor = AIUtil.FindText("Total Price") price = AIUtil.FindText(micAnyText, micWithAnchorOnLeft, anchor).GetText MsgBox price
You can consolidate the last lines into one:
'The following example prints the price displayed to the right of the Total Price label AIUtil.SetContext Device("device") 'Set the context for AI MsgBox AIUtil.FindText(micAnyText, micWithAnchorOnLeft, AIUtil.FindText("Total Price")).GetText
Highlight Method
Description
Highlights the text in the application.
Syntax
AIUtil.FindText(text, [locator], [locatorData]).Highlight
Return Type
None
Example
'The following example draws a rectangle that flashes for a second around ' the identified text. AIUtil.SetContext Device("device") 'Set the context for AI AIUtil.FindText("User Name").Highlight
Hover Method
Supported in UFT One versions 15.0.1 and later.
Description
Holds the cursor over the text.
Syntax
AIUtil.FindText(text, [locator], [locatorData]).Hover [duration]
Arguments
Parameter | Description |
---|---|
duration |
Optional. An Integer value. The time period (in whole seconds) to hold the cursor over the text. Default: 2 seconds. |
Return Type
None
IMPORTANT
This method is supported only on Web applications running in a Web browser on a Desktop computer and not on mobile devices.
Before a Hover step, use the AIUtil.IsMobileContext to make sure the current AI context is a desktop web browser.
Designing your test this way makes it easier to use the same test for your web application on various platforms.
Example
'The following example checks that the browser is not on a ' mobile device before performing a Hover step. AIUtil.SetContext Browser("browser") 'Set the context for AI IsMobile = AIUtil.IsMobileContext If IsMobile = False Then AIUtil.FindText("Categories").Hover 'Hover over the menu AIUtil.FindText ("Clothing").Click 'Click a menu item EndIf
Type Method
Supported in UFT One versions 15.0.2 and later.
Description
Types the specified string in an input or edit box identified as text.
Syntax
AIUtil.FindText(text, [locator], [locatorData]).Type [text]
Arguments
Parameter | Description |
---|---|
text |
Required. A String value. The string to type. |
Return Type
None
Example
'The following example types a user name in the edit box. AIUtil.SetContext Device("device") 'Set the context for AI AIUtil.FindText("USER NAME").Type "AIUser"
TypeSecure Method
Supported in UFT One versions 15.0.2 and later.
Description
Types the specified encrypted string in an input or edit box identified as text.
Syntax
AIUtil.FindText(text, [locator], [locatorData]).TypeSecure [text]
Arguments
Parameter | Description |
---|---|
text |
Required. A String value. The encrypted string to type. |
Return Type
None
IMPORTANT
To find the encrypted value to use as the argument for the TypeSecure method, use the Password Encoder utility (Start > All Programs > Unified Functional Testing > Tools > Password Encoder) or parameterize the argument and use the Data Table encryption option (right-click each unencrypted value in the password column and choose Data > Encrypt). For more information, see the Unified Functional Testing Help.
Note: While the TypeSecure method enables you to hide passwords on the screen when running a test, it is not intended to be a secure way to protect password information.
Example
'The following example types an encrypted password in the edit box. AIUtil.SetContext Device("device") 'Set the context for AI AIUtil.FindText("PASSWORD").TypeSecure "5cfe0d56013bbd8b5742b597cadc92352a6c"
Exist Property
Description
Checks whether the object currently exists in the set context.
Syntax
AIUtil.FindText(text, [locator], [locatorData]).Exist([TimeOut])
Arguments
Parameter | Description |
---|---|
TimeOut | Optional. An unsigned long integer value. The length of time (in seconds) to search for the object before returning a True or False value.
Note: A value of 0 is not supported for Mobile test objects. For more information on the Object Synchronization Timeout, see the UFT One Help Center. |
Remarks
UFT One versions 15.0.2 and later: The Exist property can only be used in statements that use its return value. For example, assignment, print, and if statements.
Return Type
A Boolean value
Example
'The following example checks whether the "wrong password" 'string exists in the application screen. AIUtil.SetContext Device("device") 'Set the context for AI If AIUtil.FindText("wrong password").Exist Then MsgBox "login failed." End If