AITextObject Object

Description

An internal object used to perform operations on text identified by AI in web or mobile applications.

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

Method CaptureBitmap

Saves a screen capture of the object as a .png or .bmp image using the specified file name.

Supported on UFT One 2021 R1 or later.

Method CheckExists

A checkpoint that checks whether the object currently exists in the set context.

Method ClickClicks the text.
Method DoubleClick

Double-clicks the AI text object.

Supported on UFT One 2021 R1 or later.

Method GetText

Retrieves the object’s text.

Method GetValueRetrieves the object’s value.
Method HighlightHighlights the text in the application.
Method Hover

Holds the cursor over the text.

Method LongClick

Presses and holds the AI text object for a specified number of seconds.

Supported on UFT One 2021 R1 or later.

Method MultiClick

Clicks the AI text object the specified number of times.

Supported on UFT One 2021 R1 or later.

Method RightClick

Right-clicks the AI text object.

Supported on UFT One 2021 R1 or later.

Method Type

Types the specified string in an input or edit box identified as text.

Method TypeSecure

Types the specified encoded string in an input or edit box identified as text.

Properties

Common Property ExistChecks whether the object currently exists in the set context.

Back to top

CaptureBitmap Method

Supported on UFT One 2021 R1 or later.

Description

Saves a screen capture of the object as a .png or .bmp image using the specified file name.

Syntax

AIUtil.FindText(text, [locator], [locatorData]).CaptureBitmap  FullFileName, [OverrideExisting]

Arguments

ParameterDescription
FullFileName

Required. A String value.

The path to the file to store the screen capture. The file extension indicates whether to save the capture as a .png or .bmp file.

OverrideExisting

Optional. A Boolean value.

Indicates what to do if a file by the specified name already exists: 

True: Replace the existing file with the new capture.

False (Default): The step fails if a file by the specified name already exists.

Return Type

None

Examples

Back to top

 

CheckExists Method

Description

A checkpoint that checks whether the object currently exists in the set context.

Syntax

AIUtil.FindText(text, [locator], [locatorData]).CheckExists expected

Arguments

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

  • UFT One directly performs this method without verifying object identification even if you enable it in Options > GUI Testing > AI or use the AIUtil.RunSettings.VerifyIdentification.Enable step.

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

Back to top

 

Click Method

Description

Clicks the AI text object.

Syntax

AIUtil.FindText(text, [locator], [locatorData]).Click [x], [y]

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

Back to top

 

DoubleClick Method

Supported on UFT One 2021 R1 or later.

Description

Double-clicks the AI text object.

Syntax

AIUtil.FindText(text, [locator], [locatorData]).DoubleClick  [x], [y]

Arguments

ParameterDescription
x Optional. 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.  The default value is the middle of the object (-9999).
y Optional. 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.  The default value is the middle of the object (-9999).

Return Type

None

IMPORTANT

The DoubleClick method is not supported on mobile applications.

Example

Back to top

 

GetText Method

Description

Retrieves the object’s text.

Syntax

AIUtil.FindText(text, [locator], [locatorData]).GetText

Return Type

String

Example

Back to top

 

GetValue Method

Description

Retrieves the object’s value.

Syntax

AIUtil.FindText(text, [locator], [locatorData]).GetValue

Return Type

String

Example

Back to top

 

Highlight Method

Description

Highlights the text in the application.

Syntax

AIUtil.FindText(text, [locator], [locatorData]).Highlight

Return Type

None

Example

Back to top

 

Hover Method

Description

Holds the cursor over the text.

Syntax

AIUtil.FindText(text, [locator], [locatorData]).Hover [duration]

Arguments

ParameterDescription
duration

Optional. An Integer value.

The time period (in whole seconds) to hold the cursor over the object.

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

Back to top

 

LongClick Method

Supported on UFT One 2021 R1 or later.

Description

Presses and holds the AI text object for a specified number of seconds.

Syntax

AIUtil.FindText(text, [locator], [locatorData]).LongClick [duration], [x], [y]

Arguments

ParameterDescription
duration

Optional. A double floating value. The number of seconds to press the object.

Default: 2 seconds

x Optional. An integer value.
The x-coordinate of the long 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 long 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

IMPORTANT

The LongClick method is not supported on mobile applications.

Example

Back to top

 

MultiClick Method

Supported on UFT One 2021 R1 or later.

Description

Clicks the AI text object the specified number of times.

Syntax

AIUtil.FindText( text, [locator], [locatorData]).MultiClick [numberOfClicks ], [interval], [x], [y]

Arguments

ParameterDescription
numberOfClicks

Required. An integer value. The number of times to click.

interval

Optional. A double floating value.

The number of seconds between clicks. The default value is 0.5 seconds.

x Optional. An integer value.
The x-coordinate of the clicks. 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 clicks. 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

Back to top

RightClick Method

Supported on UFT One 2021 R1 or later.

Description

Right-clicks the AI  text object.

Syntax

AIUtil.FindText( text, [locator], [locatorData]).RightClick [x], [y]

Arguments

ParameterDescription
x Optional. An integer value.
The x-coordinate of the long 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 long 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

IMPORTANT

The RightClick method is not supported on mobile applications.

Example

Back to top

 

Type Method

Description

Types the specified string in an input or edit box identified as text.

Syntax

AIUtil.FindText(text, [locator], [locatorData]).Type  [text]

Arguments

ParameterDescription
text Required. A String value.
The string to type.

Return Type

None

Example

Back to top

 

TypeSecure Method

Description

Types the specified encoded string in an input or edit box identified as text.

Syntax

AIUtil.FindText(text, [locator], [locatorData]).TypeSecure  [text]

Arguments

ParameterDescription
text Required. A String value.
The encoded string to type.

Return Type

None

IMPORTANT

To find the encoded value to use as the argument for the TypeSecure method, use the Password Encoder utility (Start > All Programs > Micro Focus > 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 UFT One Help Center.

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

Back to top

 

Exist Property

Description

Checks whether the object currently exists in the set context.

Syntax

AIUtil.FindText(text, [locator], [locatorData]).Exist([TimeOut])

Arguments

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

  • If a timeout value is specified, UFT One waits until it finds the object or until the timeout is reached.

  • If no value is specified, the value specified in the Test Settings dialog box for the Object Synchronization Timeout is used for tests. For business components, the pre-defined value of 20 seconds is used.

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

  • The Exist property can only be used in statements that use its return value. For example, assignment, print, and if statements.

  • UFT One directly performs this method without verifying object identification even if you enable it in Options > GUI Testing > AI or use the AIUtil.RunSettings.VerifyIdentification.Enable step.

Return Type

A Boolean value

Example

Back to top