GridItemTO
UIA Pro is supported as a technical preview.
GridItemTO
Constructor
new GridItemTO()
A UIAPro grid item.
Members
displayName
Returns the object display name defined in the Application Model.
Methods
$(description) → {*}
Creates a child test object of this test object.
This operation does not search for the object in the AUT. The interaction with the application occurs only when a step runs and performs an operation on the AUT object.
Parameters:
Name | Type | Description |
---|
description | Description | The 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. |
Returns:
the new child test object with the provided description.
-
Type
- *
$$(description, dontFilterByTypeopt) → {Promise.<Array.<TestObject>>}
Returns all child objects of this object that match the supplied test object description.
Parameters:
Name | Type | Attributes | Default | Description |
---|
description | | | | A 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. |
dontFilterByType | boolean |
<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>>
absX() → {Promise.<number>}
Returns the object's absolute x-coordinate (left) relative to the parent object (in pixels).
Returns:
a promise that is fulfilled with absolute x-coordinate (left) relative to the parent object (in pixels).
-
Type
- Promise.<number>
absY() → {Promise.<number>}
Returns the object's absolute y-coordinate (top) relative to the parent object (in pixels).
Returns:
a promise that is fulfilled with absolute y-coordinate (top) relative to the parent object (in pixels).
-
Type
- Promise.<number>
acceleratorKey() → {Promise.<string>}
Returns the sequence of key combinations that invoke an action associated with the element.
Returns:
a promise that is fulfilled with the object's accelerator key.
-
Type
- Promise.<string>
accessKey() → {Promise.<string>}
Returns the character that is used to activate the object.
Returns:
a promise that is fulfilled with the object's access key.
-
Type
- Promise.<string>
automationId() → {Promise.<string>}
Returns the ID for an object that is unique among siblings within its container.
Returns:
a promise that is fulfilled with the object's automation id.
-
Type
- Promise.<string>
click(argsopt) → {Promise.<void>}
Clicks on this object using the definitions from the supplied args object.
If you do not provide the args object, the click is performed in the center of the object using the left mouse button.
Parameters:
Name | Type | Attributes | Description |
---|
args | Object |
<optional>
| The arguments for the click operation.
PropertiesName | Type | Attributes | Default | Description |
---|
button | MouseButton |
<optional>
|
MouseButton.left
| The mouse button to use for the click. | anchor | Position |
<optional>
|
Position.center
| The position within the object from which the offset is taken. | offset | Object |
<optional>
| | The offset from the anchor position.
PropertiesName | Type | Attributes | Default | Description |
---|
x | number |
<optional>
|
0
| The x-coordinate of the offset. | y | number |
<optional>
|
0
| The y-coordinate of the offset. |
|
|
Returns:
a promise that is fulfilled when the click operation ends.
-
Type
- Promise.<void>
controlType() → {Promise.<string>}
Returns the UIAPro type for the object.
Returns:
a promise that is fulfilled with the object's control type.
-
Type
- Promise.<string>
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
- *
exists(timeoutopt) → {Promise.<boolean>}
Checks whether this object exists in the AUT.
Parameters:
Name | Type | Attributes | Description |
---|
timeout | number |
<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>
expandCollapsePattern() → {ExpandCollapsePattern}
Returns the expand collapse pattern class of the test object, providing access to the relevant methods and properties.
Returns:
The UIA Pro expand collapse pattern.
-
Type
- ExpandCollapsePattern
frameworkId() → {Promise.<string>}
Returns the name of the UI framework, such as Win32, WinForm, or DirectUI.
Returns:
a promise that is fulfilled with the object's framework id.
-
Type
- Promise.<string>
getTextLocations(text, rectangleopt) → {Promise.<Object>}
Returns all rectangular areas containing the specified text within this object.
Parameters:
Name | Type | Attributes | Description |
---|
text | string | | The text to search for in the test object. |
rectangle | Object |
<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:
Name | Type | Attributes | Description |
---|
rectangle | Object |
<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>
gridItemPattern() → {GridItemPattern}
Returns the grid item pattern class of the test object, providing access to the relevant methods and properties.
Returns:
The UIA Pro grid item pattern.
-
Type
- GridItemPattern
gridPattern() → {GridPattern}
Returns the grid pattern class of the test object, providing access to the relevant methods and properties.
Returns:
The UIA Pro grid pattern.
-
Type
- GridPattern
handle() → {Promise.<number>}
Returns the object's handle.
Returns:
a promise that is fulfilled with the object's handle.
-
Type
- Promise.<number>
hasKeyBoardFocus() → {Promise.<boolean>}
Returns a value that indicates whether the object has keyboard focus.
Returns:
a promise that is fulfilled with a value that indicates whether the object has keyboard focus.
-
Type
- Promise.<boolean>
height() → {Promise.<number>}
Returns the object's height (in pixels).
Returns:
a promise that is fulfilled with the value of the object's height (in pixels).
-
Type
- Promise.<number>
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:
Name | Type | Attributes | Default | Description |
---|
description | | | | A 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. |
dontFilterByType | boolean |
<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>
invokePattern() → {InvokePattern}
Returns the invoke pattern class of the test object, providing access to the relevant methods and properties.
Returns:
The UIA Pro invoke pattern.
-
Type
- InvokePattern
isEnabled() → {Promise.<boolean>}
Returns a value that indicates whether the object is enabled.
Returns:
a promise that is fulfilled with a value that indicates whether the object is enabled.
-
Type
- Promise.<boolean>
isKeyboardFocusable() → {Promise.<boolean>}
Returns a value that indicates whether the object can accept keyboard focus.
Returns:
a promise that is fulfilled with a value that indicates whether the object can accept keyboard focus.
-
Type
- Promise.<boolean>
isOffScreen() → {Promise.<boolean>}
Returns a value that indicates whether the object is Offscreen.
Returns:
a promise that is fulfilled with a value that indicates whether the object is Offscreen.
-
Type
- Promise.<boolean>
isPassword() → {Promise.<boolean>}
Returns a value that indicates whether the object contains protected content or a password.
Returns:
a promise that is fulfilled with a value that indicates whether the object contains protected content or a password.
-
Type
- Promise.<boolean>
legacyAccessiblePattern() → {LegacyAccessiblePattern}
Returns the legacy accessible pattern class of the test object, providing access to the relevant methods and properties.
Returns:
The UIA Pro legacy accessible pattern.
-
Type
- LegacyAccessiblePattern
name() → {Promise.<string>}
Returns the name of the control.
Returns:
a promise that is fulfilled with the object's name.
-
Type
- Promise.<string>
nativeClass() → {Promise.<string>}
Returns the native class of the object.
Returns:
a promise that is fulfilled with the object's native class.
-
Type
- Promise.<string>
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
- *
path() → {Promise.<string>}
Returns the path in the application's object hierarchy, separated by semicolons. Objects in the path are represented by their name or automationId property values.
Returns:
a promise that is fulfilled with the object's path.
-
Type
- Promise.<string>
processId() → {Promise.<number>}
Returns the UIAutomation object process id.
Returns:
a promise that is fulfilled with the value of the UIAutomation object process id.
-
Type
- Promise.<number>
processName() → {Promise.<string>}
Returns the UIAutomation object process name.
Returns:
a promise that is fulfilled with the value of the UIAutomation object process name.
-
Type
- Promise.<string>
rangeValuePattern() → {RangeValuePattern}
Returns the range value pattern class of the test object, providing access to the relevant methods and properties.
Returns:
The UIA Pro range value pattern.
-
Type
- RangeValuePattern
Returns the scroll item pattern class of the test object, providing access to the relevant methods and properties.
Returns:
The UIA Pro scroll item pattern.
-
Type
- ScrollItemPattern
Returns the scroll pattern class of the test object, providing access to the relevant methods and properties.
Returns:
The UIA Pro scroll pattern.
-
Type
- ScrollPattern
selectionItemPattern() → {SelectionItemPattern}
Returns the selection item pattern class of the test object, providing access to the relevant methods and properties.
Returns:
The UIA Pro selection item pattern.
-
Type
- SelectionItemPattern
selectionPattern() → {SelectionPattern}
Returns the selection pattern class of the test object, providing access to the relevant methods and properties.
Returns:
The UIA Pro selection pattern.
-
Type
- SelectionPattern
sendKeys(inputopt, modifiersopt) → {Promise.<void>}
Sends keyboard keys to an object.
Parameters:
Name | Type | Attributes | Default | Description |
---|
input | string |
<optional>
| | The string to send to the object. Use FunctionKeys and Keys for special keys. |
modifiers | KeyModifier |
<optional>
|
KeyModifier.none
| The modifier keys. Use KeyModifier for this parameter. |
Returns:
a promise that is fulfilled when the sendKeys operation ends.
-
Type
- Promise.<void>
snapshot(optionsopt) → {Promise.<string>}
Captures and returns a Base64 representation of this test object.
Parameters:
Name | Type | Attributes | Description |
---|
options | Object |
<optional>
| An options object that defines the image capture preferences.
PropertiesName | Type | Attributes | Default | Description |
---|
format | string |
<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>
status() → {Promise.<string>}
Returns a value that describes a status of the current object.
For example, an item associated with a contact in a messaging application might be "Busy" or "Connected".
Returns:
a promise that is fulfilled with a value that describes a status of the current object.
-
Type
- Promise.<string>
supportedPatterns() → {Promise.<Array.<string>>}
Returns the list of patterns supported by the object in the application.
Returns:
a promise that is fulfilled with the object's supported patterns.
-
Type
- Promise.<Array.<string>>
tableItemPattern() → {TableItemPattern}
Returns the table item pattern class of the test object, providing access to the relevant methods and properties.
Returns:
The UIA Pro table item pattern.
-
Type
- TableItemPattern
tablePattern() → {TablePattern}
Returns the table pattern class of the test object, providing access to the relevant methods and properties.
Returns:
The UIA Pro table pattern.
-
Type
- TablePattern
textPattern() → {TextPattern}
Returns the text pattern class of the test object, providing access to the relevant methods and properties.
Returns:
The UIA Pro text pattern.
-
Type
- TextPattern
togglePattern() → {TogglePattern}
Returns the toggle pattern class of the test object, providing access to the relevant methods and properties.
Returns:
The UIA Pro toggle pattern.
-
Type
- TogglePattern
valuePattern() → {ValuePattern}
Returns the value pattern class of the test object, providing access to the relevant methods and properties.
Returns:
The UIA Pro value pattern.
-
Type
- ValuePattern
verifyImageExists(imageToFind, similarityopt) → {Promise.<Object>}
Checks whether a snapshot of this object contains the supplied image.
Parameters:
Name | Type | Attributes | Description |
---|
imageToFind | string | | A Base64 string representation of the image to look for within the test object's snapshot. |
similarity | number |
<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:
Name | Type | Attributes | Description |
---|
expectedImage | string | | A Base64 string representation of the image to compare to the test object snapshot. |
pixelTolerance | number |
<optional>
| The percentage of pixels that can differ between the two images, and still be considered a match. Default = 0. |
rgbTolerance | number |
<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:
Name | Type | Attributes | Description |
---|
expectedImage | string | | A Base64 string representation of the image to compare to the test object snapshot. |
maskAreaImage | string | | A Base64 string representation of the image mask area to use in the image comparison. |
pixelTolerance | number |
<optional>
| The percentage of pixels that can differ between the two images, and still be considered a match. Default = 0. |
rgbTolerance | number |
<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>
waitUntilExists(timeoutopt) → {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:
Name | Type | Attributes | Description |
---|
timeout | number |
<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>
width() → {Promise.<number>}
Returns the object's width (in pixels).
Returns:
a promise that is fulfilled with the value of the object's width (in pixels).
-
Type
- Promise.<number>
windowPattern() → {WindowPattern}
Returns the window pattern class of the test object, providing access to the relevant methods and properties.
Returns:
The UIA Pro window pattern.
-
Type
- WindowPattern
x() → {Promise.<number>}
Returns the object's x-coordinate (left) relative to the parent object (in pixels).
Returns:
a promise that is fulfilled with x-coordinate (left) relative to the parent object (in pixels).
-
Type
- Promise.<number>
y() → {Promise.<number>}
Returns the object's y-coordinate (top) relative to the parent object (in pixels).
Returns:
a promise that is fulfilled with y-coordinate (top) relative to the parent object (in pixels).
-
Type
- Promise.<number>