Share this page

# EditTO

## StdWin. EditTO

EditTO

## Constructor

## new EditTO()

An EditField object

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

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

## 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 with the object's absolute coordinates.

Type
  Promise.<Point>

## 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. ###### Properties
Name | 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. ###### Properties
Name | 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>

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

## doubleClick(argsopt) → {Promise.<void>}

Clicks on this object using the definitions from the supplied args object. If you do not provide the args object, the double-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 double-click operation. ###### Properties
Name | Type | Attributes | Default | Description
--- | --- | --- | --- | ---
`button` | MouseButton | <optional> | MouseButton.left | The mouse button to use for the double-click.
`anchor` | Position | <optional> | Position.center | The anchor location within the object.
`offset` | Object | <optional> |  | The offset from the anchor position. ###### Properties
Name | 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 double-click operation ends.

Type
  Promise.<void>

## dragAndDropOn(target, dragOptionsopt) → {Promise.<void>}

Drags and drops a test object onto the specified target object according to the specified DragOptions behavior.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`target` | TestObject | Object |  | The target object on which this object is dropped.
`dragOptions` | Object | <optional> | The drag and drop behavior to apply. ###### Properties
Name | Type | Attributes | Default | Description
--- | --- | --- | --- | ---
`button` | MouseButton | <optional> | MouseButton.left | The mouse button used to drag the object.
`dragLocation` | Location | <optional> |  | The point on the source object where the drag operation begins.
`dropLocation` | Location | <optional> |  | The point on the target object where the drag and drop operation ends.

##### Returns:

a promise that is fulfilled when the drop operation ends.

Type
  Promise.<void>

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

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>

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

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

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

## isRightAligned() → {Promise.<boolean>}

Checks if the object is right aligned.

##### Returns:

a promise that is fulfilled with an indication of whether the object is right aligned or not.

Type
  Promise.<boolean>

## isRightToLeftLayout() → {Promise.<boolean>}

Checks if the object is right to left layout.

##### Returns:

a promise that is fulfilled with an indication of whether the object is right to left layout or not.

Type
  Promise.<boolean>

## isRightToLeftReading() → {Promise.<boolean>}

Checks if the object is right to left reading.

##### Returns:

a promise that is fulfilled with an indication of whether the object is right to left reading or not.

Type
  Promise.<boolean>

## location() → {Promise.<Point>}

Returns the object's coordinates relative to the parent window (in pixels), format: {x,y}.

##### Returns:

a promise that is fulfilled with the object's relative coordinates.

Type
  Promise.<Point>

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

## select(fromCharPos, toCharPos) → {Promise.<void>}

Selects a block of text in the edit field.

##### Parameters:

Name | Type | Description
--- | --- | ---
`fromCharPos` | number | The start position of selection.
`toCharPos` | number | The end position of selection.

##### Returns:

a promise that is fulfilled when the select operation ends.

Type
  Promise.<void>

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

## setSecure(encodedText) → {Promise.<void>}

Sets secure text for the edit field.

##### Parameters:

Name | Type | Description
--- | --- | ---
`encodedText` | string | The encoded text to set to the edit field.

##### Returns:

a promise that is fulfilled when the setSecure operation ends.

Type
  Promise.<void>

## setText(text) → {Promise.<void>}

Sets text for the edit field.

##### Parameters:

Name | Type | Description
--- | --- | ---
`text` | string | The text to set to the edit field

##### Returns:

a promise that is fulfilled when the setText operation ends.

Type
  Promise.<void>

## size() → {Promise.<Size>}

Returns the object's size (in pixels).

##### Returns:

a promise that is fulfilled with the object's size.

Type
  Promise.<Size>

## 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. ###### Properties
Name | 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>

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

Tips to improve your search results... UFT Developer JavaScript SDK Reference Version 15.0-15.0.2 UFT Developer SDK Reference All View Local Help Center View Online Help Center back Go back in browser history forward Go forward in browser history Remove search highlights next topic Go to next topic previous topic Go to previous topic Print the current topic Version: