Edit

Web. Edit

new Edit(propsopt) → {Edit}

The description of a Web Edit test object.
Parameters:
NameTypeAttributesDescription
propsObject <optional>
Initializes the description using the supplied property bag.
Returns:
the description object that was initialized.
Type
Edit

Methods

absoluteLocation(locationopt) → {Point|Description}

The object's absolute coordinates relative to the screen (in pixels). 0,0 is always the top-left corner of the (primary) monitor.
Parameters:
NameTypeAttributesDescription
locationPoint <optional>
When provided, this method acts as a setter and sets the absoluteLocation value.
Returns:
If no parameter is provided, the method acts as a getter and returns the absoluteLocation value; otherwise it returns 'this' for use with the builder pattern.
Type
Point | Description

accessibilityName(valueopt) → {string|Description}

The label of the object (where no text label is available).
Parameters:
NameTypeAttributesDescription
valuestring <optional>
When provided, this method acts as a setter and sets the accessibilityName value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored accessibilityName value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

attributes(attributesopt) → {Object|Description}

The object's DOM attributes.
Parameters:
NameTypeAttributesDescription
attributesObject <optional>
When provided, this method acts as a setter and sets the attributes value. Specify the attribute names as object keys and set their values to the desired attribute values.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored attrs object; otherwise it returns 'this' for use with the builder pattern.
Type
Object | Description

className(nameopt) → {string|Description}

The object's CSS class (className property).
Parameters:
NameTypeAttributesDescription
namestring <optional>
When provided, this method acts as a setter and sets the className value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored className value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

css(selectoropt) → {string|Description}

The path to this object in CSS format. For example: tr.BPTRow input.
Parameters:
NameTypeAttributesDescription
selectorstring <optional>
When provided, this method acts as a setter and sets the css value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored css value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

defaultValue(defaultValueopt) → {string|Description}

The default value in the edit field.
Parameters:
NameTypeAttributesDescription
defaultValuestring <optional>
When provided, this method acts as a setter and sets the defaultValue value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored defaultValue value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

id(idopt) → {string|Description}

The object's HTML identifier.
Parameters:
NameTypeAttributesDescription
idstring <optional>
When provided, this method acts as a setter and sets the HTML id value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored HTML id value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

index(valueopt) → {number|Description}

The 0-based index of this object, relative to all other objects with an otherwise identical description.
Parameters:
NameTypeAttributesDescription
valuenumber <optional>
When provided, this method acts as a setter and sets the index to the specified value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored index; otherwise it returns 'this' for use with the builder pattern.
Type
number | Description

innerHTML(innerHTMLopt) → {string|Description}

The HTML code contained between the object's start and end tags.
Parameters:
NameTypeAttributesDescription
innerHTMLstring <optional>
When provided, this method acts as a setter and sets the innerHTML value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored innerHTML value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

innerText(innerTextopt) → {string|Description}

The text contained between the object's start and end tags.
Parameters:
NameTypeAttributesDescription
innerTextstring <optional>
When provided, this method acts as a setter and sets the innerText value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored innerText value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

isReadOnly(readOnlyopt) → {boolean|Description}

Indicates whether this field is read-only.
Parameters:
NameTypeAttributesDescription
readOnlyboolean <optional>
When provided, this method acts as a setter and sets the isReadOnly value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isReadOnly value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isRequired(isRequiredopt) → {boolean|Description}

Indicates whether this field is mandatory.
Parameters:
NameTypeAttributesDescription
isRequiredboolean <optional>
When provided, this method acts as a setter and sets the isRequired value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isRequired value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isVisible(visibleopt) → {boolean|Description}

Indicates whether the object is visible.
Parameters:
NameTypeAttributesDescription
visibleboolean <optional>
When provided, this method acts as a setter and sets the isVisible value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isVisible value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

location(locationopt) → {Point|Description}

The object's coordinates relative to the parent window (in pixels).
Parameters:
NameTypeAttributesDescription
locationPoint <optional>
When provided, this method acts as a setter and sets the location value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored location value; otherwise it returns 'this' for use with the builder pattern.
Type
Point | Description

maxCharsInLine(valueopt) → {number|Description}

The maximum number of characters allowed per line in this edit field.
Parameters:
NameTypeAttributesDescription
valuenumber <optional>
When provided, this method acts as a setter and sets the maxCharsInLine value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored maxCharsInLine value; otherwise it returns 'this' for use with the builder pattern.
Type
number | Description

maxLength(maxLengthopt) → {number|Description}

The maximum number of characters that can be entered in the input field.
Parameters:
NameTypeAttributesDescription
maxLengthnumber <optional>
When provided, this method acts as a setter and sets the maxLength value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored maxLength value; otherwise it returns 'this' for use with the builder pattern.
Type
number | Description

name(nameopt) → {string|Description}

The object's name property.
Parameters:
NameTypeAttributesDescription
namestring <optional>
When provided, this method acts as a setter and sets the name value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored name value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

outerHTML(outerHTMLopt) → {string|Description}

The object's HTML code and its content.
Parameters:
NameTypeAttributesDescription
outerHTMLstring <optional>
When provided, this method acts as a setter and sets the outerHTML value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored outerHTML value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

outerText(outerTextopt) → {string|Description}

The object's text (supported in Internet Explorer only).
Parameters:
NameTypeAttributesDescription
outerTextstring <optional>
When provided, this method acts as a setter and sets the outerText value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored outerText value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

pattern(patternopt) → {string|Description}

The pattern in the edit field.
Parameters:
NameTypeAttributesDescription
patternstring <optional>
When provided, this method acts as a setter and sets the pattern value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored pattern value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

placeholder(placeholderopt) → {string|Description}

The hint text that is displayed in the edit box until a value is entered in it.
Parameters:
NameTypeAttributesDescription
placeholderstring <optional>
When provided, this method acts as a setter and sets the placeholder value.
Returns:
If no parameter is provided, the method acts as a getter and returns the placeholder value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

role(roleValueopt) → {string|Description}

The defined role of this object. For example, if the role property is listbox, the object functions as a list box.
Parameters:
NameTypeAttributesDescription
roleValuestring <optional>
When provided, this method acts as a setter and sets the role value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored role value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

rowsCount(rowsCountopt) → {number|Description}

The number of rows that can be entered in the input field.
Parameters:
NameTypeAttributesDescription
rowsCountnumber <optional>
When provided, this method acts as a setter and sets the rowsCount value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored rowsCount value; otherwise it returns 'this' for use with the builder pattern.
Type
number | Description

size(sizeopt) → {Size|Description}

The object's size (in pixels).
Parameters:
NameTypeAttributesDescription
sizeSize <optional>
When provided, this method acts as a setter and sets the size value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored size value; otherwise it returns 'this' for use with the builder pattern.
Type
Size | Description

styles(stylesopt) → {Object|Description}

The object's computed style.
Parameters:
NameTypeAttributesDescription
stylesObject <optional>
When provided, this method acts as a setter and sets the object by its computed style value. * Specify the style names as object keys and set their values to the desired style values.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored styles object; otherwise it returns 'this' for use with the builder pattern.
Type
Object | Description

tagName(tagopt) → {string|Description}

The object's HTML tag.
Parameters:
NameTypeAttributesDescription
tagstring <optional>
When provided, this method acts as a setter and sets the HTML tagName value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored HTML tagName value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

title(titleopt) → {string|Description}

The object's title.
Parameters:
NameTypeAttributesDescription
titlestring <optional>
When provided, this method acts as a setter and sets the title value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored title value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

type(typeopt) → {string|Description}

The type of object as defined in the HTML input tag.
Parameters:
NameTypeAttributesDescription
typestring <optional>
When provided, this method acts as a setter and sets the type value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored type value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

value(valueopt) → {string|Description}

The current text in this field.
Parameters:
NameTypeAttributesDescription
valuestring <optional>
When provided, this method acts as a setter and sets the value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

vri(valueopt)

Sets a VisualRelation definition.
The VRI definition helps to distinguish this object from other objects with otherwise identical descriptions, based on this object's visual relationship to another object in the application.
Parameters:
NameTypeAttributesDescription
valueArray.<Object> <optional>
Array that contains multiple VRI definitions for this test object.
Properties
NameTypeAttributesDefaultDescription
anchorObjectThe related test object.
horizontalHorizontal <optional>
The horizontal relation definition.
hInlineboolean <optional>
false The horizontal inline definition.
verticalVertical <optional>
The vertical relation definition.
vInlinestring <optional>
false The vertical inline definition.
proximityProximity <optional>
The proximity relation definition.

xpath(selectoropt) → {string|Description}

The path to this object in XPath format. For example: //TR[@id='LeanFT']/*\/INPUT
Parameters:
NameTypeAttributesDescription
selectorstring <optional>
When provided, this method acts as a setter and sets the xpath value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored xpath value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description