PageTO

Web. PageTO

PageTO

Constructor

new PageTO()

An HTML page.

Members

displayName

Returns the object display name defined in the Application Model.

Methods

$(selector, objTypeopt) → {*}

Creates a child test object of this test object. This operation does not cause UFT Developer to search for the object in the AUT. UFT Developer interacts with the application only when a step runs that performs an operation on the AUT object.
Parameters:
NameTypeAttributesDefaultDescription
selectorDescription | stringThe description of the test object. Can be a full test object description or a string. If a string is provided, it is interpreted as a CSS selector with a default test object type of WebElement.
objTypeDescription <optional>
Web.Element() The type of test object to use when supplying a CSS string for the selector.
Returns:
the new child test object with the provided description.
Type
*

$$(selector, dontFilterByTypeopt) → {Promise.<Array.<TestObject>>}

Returns all child objects of this object that match the supplied test object description.
Parameters:
NameTypeAttributesDefaultDescription
selectorDescription | stringa description object that defines the test object type and the set of properties and values that should be common to all objects that are returned.
dontFilterByTypeboolean <optional>
false Set this parameter to true to avoid limiting the returned objects to a specific test object type.
Returns:
a promise that is fulfilled with an array of test objects that match the supplied description.
Type
Promise.<Array.<TestObject>>

$x(xpath, childTypeopt) → {*}

Creates a child test object of this test object based on the specified xpath. This operation does not cause UFT Developer to search for the object in the AUT. UFT Developer interacts with the application only when a step runs that performs an operation on the AUT object.
Parameters:
NameTypeAttributesDefaultDescription
xpathstringThe xpath to use as the description for the new child test object.
childTypeDescription <optional>
Web.Element() The test object type for the new child test object.
Returns:
the new child test object with the provided xpath as its description.
Type
*

absoluteLocation() → {Promise.<Point>}

Returns the object's absolute coordinates relative to the screen (in pixels), format: {x,y}.
Remark: 0,0 is always the top-left corner of the (primary) monitor.
Returns:
a promise that is fulfilled when the object's absolute coordinates are returned.
Type
Promise.<Point>

description() → {*}

Returns the description for this test object. The test object must be obtained using the $ method, otherwise, this method returns null.
Returns:
the description for this test object.
Type
*

waitUntilExists(timeout[opt]) → {Promise.<boolean>}

Waits until this test object exists or until the specified timeout elapses. This method is useful for synchronizing your test with your application.

Parameters:
NameTypeAttributesDescription
timeoutnumber <optional>
The time (in seconds) to wait for this object to exist.
By default, uses the object synchronization timeout defined in the runtime engine settings.
Returns:
a promise that is fulfilled with a boolean indicating whether the object exists.
Type
Promise.<boolean>

exists(timeoutopt) → {Promise.<boolean>}

Checks whether this object exists in the AUT.
Parameters:
NameTypeAttributesDescription
timeoutnumber <optional>
The time (in seconds) to wait for this object before returning a result of true or false.
By default, uses the object synchronization timeout defined in the runtime engine settings.
Returns:
a promise that is fulfilled with a boolean indicating whether the object exists.
Type
Promise.<boolean>

getTextLocations(text, rectangleopt) → {Promise.<Object>}

Returns all rectangular areas containing the specified text within this object.
Parameters:
NameTypeAttributesDescription
textstringThe text to search for in the test object.
rectangleObject <optional>
The rectangular area in the test object to search for the text.
Returns:
a promise that is fulfilled with an array of rectangles containing all rectangular areas containing the specified text within this object.
Type
Promise.<Object>

getVisibleText(rectangleopt) → {Promise.<string>}

Returns all visible text from this object.
Parameters:
NameTypeAttributesDescription
rectangleObject <optional>
The rectangular area in the test object to return the text from.
Returns:
a promise that is fulfilled with all the visible text from this object.
Type
Promise.<string>

highlight() → {Promise.<void>}

Highlights this object in the AUT.
Remark: This may be useful when debugging a test.
Returns:
a promise that is fulfilled when the highlighting operation ends.
Type
Promise.<void>

highlightMatches(description, dontFilterByTypeopt) → {Promise.<number>}

Highlights all children that match the supplied test object description.
Parameters:
NameTypeAttributesDefaultDescription
descriptionA description object that defines the test object type and the set of properties and values that should be common to all objects that are highlighted.
dontFilterByTypeboolean <optional>
false Set this parameter to true to avoid limiting the highlighted objects to a specific test object type.
Returns:
a promise that is fulfilled with the number of matches that are found and highlighted.
Type
Promise.<number>

nativeObject() → {Promise.<Object>}

Returns the native application object that is represented by this test object instance, enabling you to access the native properties and methods provided by that object.
Returns:
a promise that is fulfilled with the native application object that is represented by this test object instance.
Type
Promise.<Object>

parent() → {*}

Returns the parent test object of this test object. The child object must be obtained using the $ method, otherwise, this method returns null.
Returns:
the parent test object of this test object.
Type
*

runScript(script_to_run) → {Promise.<*>}

Runs the specified JavaScript code in the page's context and returns the result.
Parameters:
NameTypeDescription
script_to_runstring | functionThe JavaScript code to run. If a function is passed, it will be transformed to a string and executed in the frame's context.
Returns:
a promise this is fulfilled with the return value of the script.
Type
Promise.<*>

size() → {Promise.<Size>}

Returns the object's size (in pixels).
Returns:
a promise that is fulfilled when the object's size is returned.
Type
Promise.<Size>

snapshot(optionsopt) → {Promise.<string>}

Captures and returns a Base64 representation of this test object.
Parameters:
NameTypeAttributesDescription
optionsObject <optional>
An options object that defines the image capture preferences.
Properties
NameTypeAttributesDefaultDescription
formatstring <optional>
"png" The format of the image. Possible values: png, bmp.
Returns:
a promise that is fulfilled with the Base64 string of the test object's image.
Type
Promise.<string>

sync() → {Promise.<void>}

Waits for the page state to be idle.
Returns:
a promise that is fulfilled when the frame is idle.
Type
Promise.<void>

text() → {Promise.<string>}

Returns the inner text of the body element.
Returns:
a promise this is fulfilled with the inner text of the body element.
Type
Promise.<string>

title() → {Promise.<string>}

Returns the page's title attribute.
Returns:
a promise this is fulfilled with the page's title attribute.
Type
Promise.<string>

url() → {Promise.<string>}

Returns the URL of the HTML page.
Returns:
a promise this is fulfilled with the URL of the HTML page.
Type
Promise.<string>

verifyImageExists(imageToFind, similarityopt) → {Promise.<Object>}

Checks whether a snapshot of this object contains the supplied image.
Parameters:
NameTypeAttributesDescription
imageToFindstringA Base64 string representation of the image to look for within the test object's snapshot.
similaritynumber <optional>
The minimum similarity between the two images (as a percentage), above which the find is considered a match. Default = 100.
Returns:
a promise that is fulfilled with an object representing the point where the image was located, or null if it was not found.
Type
Promise.<Object>

verifyImageMatch(expectedImage, pixelToleranceopt, rgbToleranceopt) → {Promise.<boolean>}

Checks whether a snapshot of this object and the supplied image are a match.
Parameters:
NameTypeAttributesDescription
expectedImagestringA Base64 string representation of the image to compare to the test object snapshot.
pixelTolerancenumber <optional>
The percentage of pixels that can differ between the two images, and still be considered a match. Default = 0.
rgbTolerancenumber <optional>
The percentage by which the RGB values of the pixels in the two images can differ, and still be considered a match. Default = 0.
Returns:
a promise that is fulfilled with a boolean representing the comparison result.
Type
Promise.<boolean>

verifyImageMatchWithMask(expectedImage, maskAreaImage, pixelToleranceopt, rgbToleranceopt) → {Promise.<boolean>}

Checks whether a snapshot of this object and the supplied image are a match.
Parameters:
NameTypeAttributesDescription
expectedImagestringA Base64 string representation of the image to compare to the test object snapshot.
maskAreaImagestringA Base64 string representation of the image mask area to use in the image comparison.
pixelTolerancenumber <optional>
The percentage of pixels that can differ between the two images, and still be considered a match. Default = 0.
rgbTolerancenumber <optional>
The percentage by which the RGB values of the pixels in the two images can differ, and still be considered a match. Default = 0.
Returns:
a promise that is fulfilled with a boolean representing the comparison result.
Type
Promise.<boolean>