AIObject Object

Description

An internal object used to perform operations on an object identified using AI.

IMPORTANT

AI-based testing is supported on the following technologies:

UFT One versions 2022 and later: Web, mobile, and SAP GUI for Windows.
UFT One versions 2021 R1 and earlier: Web and mobile.

AI objects are supported in UFT One only when:

The UFT One Web Add-in, Mobile Add-in, or SAP Solutions Add-in is 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 AIObject object, use the AIUtil.AIObject default property.

Operations

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

Note: You can also view a list and descriptions of the AIObject properties that you can retrieve using the GetObjectProperty and GetAllProperties methods. You can then use the properties to check the object's location or content.

Methods

CaptureBitmap	Saves a screen capture of the AIObject as a .png or .bmp image using the specified file name. Supported on UFT One versions 2021 R1 and later.
CheckExists	A checkpoint that checks whether the object currently exists in the set context.
CheckState	A checkpoint that checks the state of the object.
Click	Clicks the AI object.
DoubleClick	Double-clicks the AI object. Supported on UFT One versions 2021 R1 and later.
GetAllProperties	Retrieves all of the AIObject's properties and their values from the application. Supported on UFT One versions 2023 and later.
GetObjectProperty	Retrieves the value of the specified object property from the application. Supported on UFT One versions 2023 and later.
GetValue	Retrieves the object's value.
Highlight	Highlights the object in the application.
Hover	Holds the cursor over the object.
LongClick	Presses and holds the AI object for a specified number of seconds. Supported on UFT One versions 2021 R1 and later.
MultiClick	Clicks the AI object the specified number of times. Supported on UFT One versions 2021 R1 and later.
RightClick	Right-clicks the AI object. Supported on UFT One versions 2021 R1 and later.
Search	Performs a search operation using an AIObject of type “Search”.
Select	Selects an item from a combo box.
SetState	Sets the state of a check box or toggle button to On or Off.
SetText	Sets the value of the object. Relevant for text boxes, input controls, and combo boxes. Supported on UFT One versions 2021 R1 and later.
SetTextSecure	Sets the encoded value of the object. Relevant for text boxes, input controls, and combo boxes. Supported on UFT One versions 2021 R1 and later.
Type	Types the specified string in the object.
TypeSecure	Types the specified encoded string in the object.

Properties

Exist

Checks whether the object currently exists in the set context.

CaptureBitmap Method

Supported on UFT One versions 2021 R1 and later.

Description

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

Syntax

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

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

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

Arguments

Parameter	Description
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.

Parameter

Description

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

Example

CheckExists Method

Description

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

Syntax

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

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

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

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.

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

CheckState Method

Description

A checkpoint that checks the state of the object.

Syntax

AIUtil.AIObject(ControlType, [text], [locator], [locatorData]).CheckState expectedState

AIUtil(ControlType, [text], [locator], [locatorData]).CheckState expectedState

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

Arguments

Parameter	Description
expectedState	A String value. Specifies the expected state of an object such as check box, radio button, or toggle. Possible values: On. The checkpoint passes if the object's state is ON. Off. The checkpoint passes if the object's state is OFF. Note: The state check is case insensitive.

Parameter

Description

expectedState

A String value. Specifies the expected state of an object such as check box, radio button, or toggle.

Possible values:

On. The checkpoint passes if the object's state is ON.

Off. The checkpoint passes if the object's state is OFF.

Note: The state check is case insensitive.

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

Click Method

Description

Clicks the AI object.

Syntax

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

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

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

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

DoubleClick Method

Supported on UFT One versions 2021 R1 and later.

Description

Double-clicks the AI object.

Syntax

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

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

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

Arguments

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

GetAllProperties Method

Supported on UFT One versions 2023 and later.

Description

Retrieves all of the AIObject's properties and their values from the application.

Syntax

AIUtil.AIObject(ControlType, [text], [locator], [locatorData]).GetAllProperties

AIUtil(ControlType, [text], [locator], [locatorData]).GetAllProperties

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

Return Type

A Dictionary object

Example

GetObjectProperty Method

Supported on UFT One versions 2023 and later.

Description

Retrieves the value of the specified object property from the object in the application.

Syntax

AIUtil.AIObject(ControlType, [text], [locator], [locatorData]).GetObjectProperty (property)

AIUtil(ControlType, [text], [locator], [locatorData]).GetObjectProperty (property)

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

Arguments

Parameter	Description
property	Required. A String. The name of the property whose value to return.

Parameter

Description

property

Required. A String.

The name of the property whose value to return.

Return Type

A Variant.

Example

GetValue Method

Description

Returns the object's value.

Syntax

AIUtil.AIObject(ControlType, [text], [locator], [locatorData]).GetValue

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

Return Type

A string. A Boolean value.

Example

Highlight Method

Description

Highlights the object in the application.

Syntax

AIUtil.AIObject(ControlType, [text], [locator], [locatorData]).Highlight

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

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

Return Type

None

Example

Hover Method

Description

Holds the cursor over the object.

Syntax

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

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

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

Arguments

Parameter	Description
duration	Optional. An Integer value. The whole number of seconds to hold the cursor over the object. Default: 2 seconds.

Parameter

Description

duration

Optional. An Integer value.

The whole number of 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

LongClick Method

Supported on UFT One versions 2021 R1 and later.

Description

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

Syntax

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

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

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

Arguments

Parameter	Description
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).

Parameter

Description

duration

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

Default: 2 seconds

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

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

Example

MultiClick Method

Supported on UFT One versions 2021 R1 and later.

Description

Clicks the AI object the specified number of times.

Syntax

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

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

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

Arguments

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

RightClick Method

Supported on UFT One versions 2021 R1 and later.

Description

Right-clicks the AI object.

Syntax

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

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

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

Arguments

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

Search Method

Description

Performs a search operation using an AIObject of type “Search”.

Syntax

AIUtil.AIObject("Search").Search [text]

AIUtil("Search").Search [text]

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

Arguments

Parameter	Description
text	Required. A String value. The string to enter in the search box.

Return Type

None

IMPORTANT

The Search method is supported only for AIObjects of type "Search". The method enters the specified string in the search box and presses Enter.

Example

Select Method

Description

Selects an item from a combo box.

Syntax

AIUtil.AIObject(ControlType, [text], [locator], [locatorData]).Select Item

AIUtil(ControlType, [text], [locator], [locatorData]).Select Item

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

Arguments

Parameter	Description
Item	Required. A String value. The item to select.

Return Type

None.

IMPORTANT

UFT One versions 2023 and later:

Mobile testing:

The Select action is supported on a combo box identified by AI only if UFT One can also identify the combo box as a MobileDropDown.

Non-mobile testing:

UFT One first tries to identify the combo box as a WebList, as the select operation is most efficient when using the object's native commands.

Otherwise, UFT One uses the AI capabilities to support the Select operation. In this case, the operation is affected by the AIRunSettings.ComboBoxSelect settings. These runtime settings tell UFT One how far and in which direction to scroll the combo box's list in search of the specified value.

The AI-based Select operation is supported on combo boxes with a single-column drop-down list that opens by clicking the box.

UFT One version 2022 and earlier:

This method is supported for ControlType combo box, only on web or mobile applications, and only in cases where UFT One can also identify this combo box as a WebList or a MobileDropDown.

Example

SetState Method

Description

Sets the state of a check box or toggle button to On or Off.

Syntax

AIUtil.AIObject(ControlType, [text], [locator], [locatorData]).SetState State

AIUtil(ControlType, [text], [locator], [locatorData]).SetState State

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

Arguments

Parameter	Description
State	Required. A String value. The state to set. Possible values: On, Off (case-insensitive)

Parameter

Description

State

Required. A String value.
The state to set.

Possible values: On, Off (case-insensitive)

Return Type

None.

IMPORTANT

This method is supported for ControlType Toggle, Check box, and Radio button.

A radio button object represents one button in a radio group. Therefore, SetState on a radio button can only set the button to On. To set a radio button to Off, you must use SetState to set a different radio button in the group to On.

Example

SetText Method

Description

Sets the value of the object.

Syntax

AIUtil.AIObject(ControlType, [text], [locator], [locatorData]).SetText [text]

AIUtil(ControlType, [text], [locator], [locatorData]).SetText [text]

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

Arguments

Parameter	Description
text	Required. A String value. The string to set in the object.

Return Type

None

IMPORTANT

This method is relevant for AIObjects that represent text boxes, input controls, and combo boxes.
This method is not supported for mobile applications.

Example

SetTextSecure Method

Description

Sets the encoded value of the object.

Syntax

AIUtil.AIObject(ControlType, [text], [locator], [locatorData]).SetTextSecure [encodedText]

AIUtil(ControlType, [text], [locator], [locatorData]).SetTextSecure [encodedText]

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

Arguments

Parameter	Description
encodedText	Required. A String value. The encoded string to set in the object.

Return Type

None

IMPORTANT

This method is relevant for AIObjects that represent text boxes, input controls, and combo boxes.
This method is not supported for mobile applications.
To find the encoded value to use as the argument for the SetTextSecure method, use the Password Encoder utility (Start > All Programs > Micro Focus > Micro Focus UFT One > 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 UFT One Help Center.
Note: While the SetTextSecure 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

Type Method

Description

Types the specified string in the object.

Syntax

AIUtil.AIObject(ControlType, [text], [locator], [locatorData]).Type [text]

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

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

Arguments

Parameter	Description
text	Required. A String value. The string to type.

Return Type

None

Example

TypeSecure Method

Description

Types the specified encoded string in the object.

Syntax

AIUtil.AIObject(ControlType, [text], [locator], [locatorData]).TypeSecure [text]

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

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

Arguments

Parameter	Description
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 > Micro Focus UFT One > 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 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

Exist Property

Description

Checks whether the object currently exists in the set context.

Syntax

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

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

Note: You can omit the AIObject property in the syntax, because AIObject is the default property for the AIUtil object.

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

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.

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.

Return Type

A Boolean value indicating whether the object exists.

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.