WebUIGridObject

Description

A ui-Grid table containing a variable number of rows and columns.

Note: For full UFT One support for ui-Grid objects, you must first enable the ui-grid API in your application.

Back to top

Operations

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

Note: You can also view a list and descriptions of the WebUIGrid description properties, for use in object repository descriptions, programmatic descriptions, checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.

Methods

Common Method CaptureBitmapSaves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the actual value of the specified object property matches the specified expected value within the specified timeout.Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjectsReturns the collection of child objects contained within the object.
Common Method GetAllROProperties

Returns the collection of properties and current values from the object in the application.

Method ChildItemReturns a test object from the cell by type and index.
Method ChildItemCountReturns the number of objects of a specific type in the specified cell.
Method ClickClicks the object.
Method ColumnCountReturns the number of columns in the table.
Method DoubleClickClicks on the object twice.
Method DragPerforms the 'drag' part of a drag and drop operation.
Method DropPerforms the 'drop' part of a drag and drop operation.
Method FireEventTriggers an event.
Method GetCellDataReturns the text contained in the specified cell.
Common Method GetROPropertyReturns the current value of the description property from the object in the application.
Method GetColumnText

Returns the text contained in a specified column, as defined by the column’s index.

Method GetRowWithCellTextReturns the number of the first row found that contains a cell with the specified text.
Common Method GetTOPropertiesReturns the collection of properties and values used to identify the object.
Common Method GetTOPropertyReturns the value of the specified description property from the test object description.
Common Method HighlightHighlights the object in the application.
Method HoverTapWhen hover is supported, places the pointer on the object. Otherwise, taps the object.
Method LongPressPresses and holds the object.
Method MiddleClickMiddle-clicks the object.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Method PanPerform a pan gesture.
Method PinchPerform a pinch gesture.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method RightClickRight-clicks the object.
Method RowCountReturns the number of rows in the table.
Method ScrollToCellContentScroll to a specified cell, as defined by its content.
MethodScrollToRow

Scrolls to a specified row, as defined by the row’s number.

Method SelectCellSelects the specified cell in the grid.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Method SubmitSubmits a form.
Method SwipeSwipes the object.
Common Method ToStringReturns a string that represents the test object.
Method Verify

Checks whether the specified property returns the specified value within the specified timeout.

Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

CellReturns a cell of type WebElement in the specified row and column.
Common Property ExistChecks whether the object currently exists in the open application.
Common Property ObjectAccesses the native methods and properties of the object.

Back to top

Cell Property

Description

Returns a cell of type WebElement in the specified row and column.

Syntax

object.Cell (Row, Column)

Arguments

ParameterDescription
Row Required. A long integer value.

The row number where the cell is located. The first row in the table is numbered 1.
Column Required. A long integer value.

The column number where the cell is located. The first column in the table is numbered 1.

Return Type

A cell of type WebElement.

Back to top

ChildItem Method

Description

Returns a test object from the cell by type and index.

Syntax

object.ChildItem (Row, Column, MicClass, Index)

Arguments

ParameterDescription
Row Required. A long integer value.
The row number where the cell is located. The first row in the table is numbered 1.
Column Required. A long integer value.
The column number where the cell is located. The first column in the table is numbered 1.
MicClass Required. A String value.
The object type.
Index Required. A long integer value.
The index of the object of type MicClass in the cell. This index indicates the desired element when there is more then one object of type MicClass in the cell. The first object has an index of 0.

Return Type

An Object.

Example

Back to top

ChildItemCount Method

Description

Returns the number of objects of a specific type in the specified cell.

Syntax

object.ChildItemCount (Row, Column, MicClass)

Arguments

ParameterDescription
Row Required. A long integer value.
The row number where the cell is located. The first row in the table is numbered 1.
Column Required. A long integer value.
The column number where the cell is located. The first column in the table is numbered 1.
MicClass Required. A String value.
The object type.

Return Type

A long integer value.

Example

Back to top

Click Method

Description

Clicks the object.

Syntax

object.Click [x], [y], [button]

Arguments

ParameterDescription
x Optional. A long integer value.
The x-coordinate of the click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999
y Optional. A long integer value.
The y-coordinate of the click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999
button Optional. A predefined constant or number.

The mouse button used to click the object.

UFT One does not record the Click method for right- or middle-clicks. Instead, UFT One records the RightClick and MiddleClick methods.


Default value = micLeftBtn

Return Type

None

IMPORTANT

  • Recording options for this method are defined in the Advanced tab of the Web Options dialog box. For details, see the section on the Web > Advanced pane in the UFT One Help Center.
  • For some Mozilla FireFox objects, this method is recorded only if a handler is present. For details, see the topic on working with multiple browsers in the UFT One Help Center.
  • If you are testing a web or hybrid application on a mobile device, this method is equivalent to performing the Tap gesture.

Example

Back to top

 

ColumnCount Method

Description

Returns the number of columns in the table.

Syntax

object.ColumnCount (Row)

Arguments

ParameterDescription
Row Required. A long integer value.

The row number. The first row in the table is numbered 1.

Return Type

A long integer value.

Example

Back to top

DoubleClick Method

Description

Clicks on the object twice.

Syntax

object.DoubleClick ([interval], [x], [y])

Arguments

ParameterDescription
interval Optional. A double floating value.
The number of seconds between the two clicks. The default value is 0.2 seconds.
x Optional. A long integer value.
The x-coordinate of the click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999
y Optional. A long integer value.

The y-coordinate of the click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.

 


Default value = -9999

Return Type

None.

IMPORTANT

  • This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab (UFT Mobile) or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

  • If you are testing a web or hybrid application on a mobile device, this method is equivalent to performing the DoubleTap gesture.

Example

Back to top

 

Drag Method

Description

Performs the 'drag' part of a drag and drop operation.

Syntax

object.Drag [x], [y], [button], [Modifier]

Arguments

ParameterDescription
x Optional. A long integer value.
The x-coordinate within the source object. 

Default = micNoCoordinate (center of the source object)


Default value = -9999
y Optional. A long integer value.
The y-coordinate within the source object.

Default = micNoCoordinate (center of the source object)


Default value = -9999
button Optional. A predefined constant or number.
The mouse button used to drag the object. (Releasing the button performs the Drop operation.)

Default = micLeftBtn (0)


Default value = micLeftBtn
Modifier Optional. A String value.
The keyboard modifier that is pressed during the Drag operation.

Possible values:
micAlt
micCtrl
micShift


Default value = 0

Return Type

None

IMPORTANT

  • Drag and Drop operations are performed as a coupled step. Inserting one operation without the other causes an error to occur in the run session.
  • This test object method is not supported on Safari browsers.

UFT One supports the following scenarios:

  • Scenario A: One object is dragged onto another object. For example, you can drag a WebButton from one frame object (source object) to another object (target object), or drag a WebElement (source object) onto a Link object (target object) in the same frame.

  • Scenario B: An object is moved from one location in a frame to another location in the same frame. In this case, the test object used for the Drag step is the same as the test object used for the Drop step.

  • Scenario C: An item within an object is moved to another location within that object (also known as drag and pan). For example, in a map application, you can relocate an image relative to itself or drag a Slider object.

General Note:

UFT One always runs Drag and Drop steps using the mouse API, even if you defined the Replay type as Event in the Run Settings section of the Web > Advanced pane (Tools > Options > GUI Testing tab >Web pane > Advanced node). 

 

Notes for Scenario A:

--Recording session. You cannot record cross-object or cross-frame types of drag and drop operations (operations in which you try to drop an object on another object or in another frame). You can, however, insert these types of Drop steps manually. Note that it may be helpful to record a drag and drop operation on the object in order to determine valid coordinates for the Drag operation step. You will need to delete the recorded Drop step, though, and manually add a new Drop step for the target object instead. 

--Run session. If the application being tested supports scrolling, then UFT One supports scrolling when the Drag and Drop test objects are both located in the same frame. UFT One drags the Drag object to edge of the frame, waits for the Drop object to appear, and drops the Drag object onto the Drop object. If the application being tested does not support scrolling, then UFT One displays an error message when it reaches a step that requires scrolling. 

--Run session. If you want to drag a test object from one frame to another, UFT One tries to make both the Drag and Drop objects visible in their frames prior to performing the Drag and Drop operation. If the two objects cannot be viewed simultaneously (for example, because the browser window is too small), the step will fail.

Notes for Scenario B and Scenario C:

--If the screen resolution during a run session is not the same as the screen resolution during the recording session, then the size of the frame may be different during the run session as compared to the recording session. In this case, the target location coordinates may be different during the run session, and this may cause the test steps to fail.

--During a run session, if the coordinates of a Drop step are located outside of the visible frame area (for example, because your application changed), then the step may not run accurately. To solve this, fix the specified coordinates, as needed. The test object can be dragged only within the visible area of the frame object. Dragging the object to the edge of a window or frame does not cause the area to scroll (as it does in Scenario A).

Example

Back to top

 

Drop Method

Description

Performs the 'drop' part of a drag and drop operation.

Syntax

object.Drop [x], [y]

Arguments

ParameterDescription
x Optional. A long integer value.
The x-coordinate of the target object on which the dragged object is dropped. If the dragged and dropped object is the same object, then the x-coordinate is relative to the upper left corner in the source location prior to being dragged.

Default = micNoCoordinate (center of the target object)


Default value = -9999
y Optional. A long integer value.
The y-coordinate of the target object on which the dragged object is dropped. If the dragged and dropped object is the same object, then the y-coordinate is relative to the upper left corner in the source location prior to being dragged.

Default = micNoCoordinate (center of the target object)


Default value = -9999

Return Type

None

IMPORTANT

  • Drag and Drop operations are performed as a coupled step. Inserting one operation without the other causes an error to occur. For more information on Drag and Drop operations, see Drag Method.
  • This test object method is not supported on Safari browsers.

Example

Back to top

 

FireEvent Method

Description

Triggers an event.

Syntax

object.FireEvent EventName, [x], [y], [button]

Arguments

ParameterDescription
EventName Required. A String value.
The name of event to trigger. Available events: onchange, onclick, ondblclick, onblur, onfocus, onmousedown, onmouseup, onmouseover, onmouseout, onsubmit, onreset, onpropertychange.
x Optional. A long integer value.
The x-coordinate, relative to the upper left corner of the object.
Default value = -9999
y Optional. A long integer value.
The y-coordinate, relative to the upper left corner of the object.
Default value = -9999
button Optional. A predefined constant or number.
The mouse button used to fire the object.
Default value = micLeftBtn

Return Type

None

Example

Back to top

 

GetCellData Method

Description

Returns the data contained in the specified cell.

Syntax

object.GetCellData (Row, Column)

Arguments

ParameterDescription
Row Required. A long integer value.
The row number where the cell is located. The first row in the table is numbered 1.
Column

Required. A Variant.

One of the following:

  • The column name where the cell is located.
  • The column number where the cell is located. The first column in the table is numbered 1.
  • The column index where the cell is located. To specify the index of the column, use '#<index>'. Index values begin with 1.

Return Type

A String value.

Returns the data contained in the specified cell.

If the specified cell is not valid, the method returns micCellDoesNotExist

Example

Back to top

GetColumnText Method

Description

Returns the text contained in a specified column, as defined by the column’s index.

Syntax

object.GetColumnText (ColumnNumber)

Arguments

ParameterDescription
ColumnNumber

Required. Integer.

The column number where the cell is located. Column numbers begin with 1.

Return Type

A String value.

Returns the data contained in the specified column.

If the specified column is not valid, the method returns micColDoesNotExist

Back to top

GetRowWithCellText Method

Description

Returns the number of the first row found that contains a cell with the specified text.

Syntax

object.GetRowWithCellText (Text, [Column], [StartFromRow])

Arguments

ParameterDescription
Text Required. A String value.

The text string for which to search.
Column Optional. A Variant.

The column number where the cell is located. The value can either be the column name or index. Index values begin with 1.

Default value = 0
StartFromRow Optional. A long integer value.

The number of the row in which to start the search. The first row in the table is numbered 1.

Default value = 0

Return Type

A long integer value.

Example

Back to top

HoverTap Method

Description

When hover is supported, places the pointer on the object. Otherwise, taps the object.

Syntax

object.HoverTap ([x], [y])

Arguments

ParameterDescription
x Optional. A long integer value.
The x-coordinate of the hover point or tap. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.

Default value = -9999
y Optional. A long integer value.
The y-coordinate of the hover point or tap. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.

Default value = -9999

Return Type

None.

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab (UFT Mobile) or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

Example

Back to top

 

LongPress Method

Description

Presses and holds the object.

Syntax

object.LongPress [duration], [x], [y]

Arguments

ParameterDescription
duration Optional. A double floating value.

The time period (in seconds) to hold the long tap gesture.

You can specify partial seconds as a duration time.


Default value = 1
x Optional. A long integer value.
The x-coordinate of the tap gesture. The coordinate is relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999
y Optional. A long integer value.
The y-coordinate of the tap gesture. The coordinate is relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999

Return Type

None

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab (UFT Mobile) or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

Back to top

 

MiddleClick Method

Description

Middle-clicks the object.

Syntax

object.MiddleClick [x], [y]

Arguments

ParameterDescription
x Optional. A long integer value.
The x-coordinate of the middle-click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999
y Optional. A long integer value.
The y-coordinate of the middle-click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999

Return Type

None

IMPORTANT

  • If UFT One does not record the MiddleClick method, it may be due to Web Event Recording Configuration settings that were preserved from the upgrade of a previous UFT One version. In this case, you can enable recording of these methods by resetting the Web Event Recording Configuration to a preconfigured level. For details, see the section on the Custom Web Even Recording Configuration dialog box in the UFT One Help Center.
  • When Event Replay is selected for the Replay type option (by using Tools > Options > GUI Testing tab >Web pane > Advanced node), UFT One fires onmousedown, focus, and onmouseup events for this method, which may cause slightly different behavior than the regular Click method with a micMiddleButton value for the Button argument.

Back to top

 

Pan Method

Description

Perform a pan gesture.

Syntax

object.Pan (deltaX, deltaY, [duration], [startX], [startY])

Arguments

ParameterDescription
deltaX Required. A long integer value.

The distance moved on the x axis, relative to the start point.

deltaY Required. A long integer value.

The distance moved on the y axis, relative to the start point.

duration Optional. A double floating value.
The number of seconds required to perform the pan gesture.
Default value = 0.5
startX Optional. A long integer value.
The x-coordinate of where the pan gesture starts. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999
startY Optional. A long integer value.
The y-coordinate of where the pan gesture starts. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999

Return Type

None.

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab (UFT Mobile) or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

This method is not supported in Internet Explorer and older versions of FireFox.

Example

Back to top

 

Pinch Method

Description

Perform a pinch gesture.

Syntax

object.Pinch (scale, [duration], [x], [y])

Arguments

ParameterDescription
scale Required. A double floating value.

The zoom scale resulting from the pinch gesture.

This is the ratio between the distance between the fingers at the end of the pinch gesture to the distance between the fingers at the beginning of the pinch gesture.

duration Optional. A double floating value.
The number of seconds required to perform the pinch gesture. The default value is 1 second.
Default value = 1
x Optional. A long integer value.
The x-coordinate of where the pinch gesture begins. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999
y Optional. A long integer value.
The y-coordinate of of where the pinch gesture begins. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999

Return Type

None.

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab (UFT Mobile) or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

This method is not supported in Internet Explorer and older versions of FireFox.

Example

Back to top

 

RightClick Method

Description

Right-clicks the object.

Syntax

object.RightClick [x], [y]

Arguments

ParameterDescription
x Optional. A long integer value.
The x-coordinate of the right-click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999
y Optional. A long integer value.
The y-coordinate of the right-click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999

Return Type

None

IMPORTANT

  • If UFT One does not record the RightClick method, it may be due to Web Event Recording Configuration settings that were preserved from the upgrade of a previous UFT One version. In this case, you can enable recording of these methods by resetting the Web Event Recording Configuration to a preconfigured level. For details, see the section on the Custom Web Even Recording Configuration dialog box in the UFT One Help Center.
  • When Event Replay is selected for the Replay type option (by using Tools > Options > GUI Testing tab >Web pane > Advanced node), UFT One fires onmousedown, focus, onmouseup, and oncontextmenu events for this method, which may cause slightly different behavior than the regular Click method with a micRightButton value for the Button argument.

Back to top

 

ScrollToCellContent Method

Description

Scrolls to a specified cell in the selected column, as defined by the cell's content.

Syntax

object.ScrollToCellContent  (Column, CellText, [CellTextIndex], [ColumnIndex])

Arguments

ParameterDescription
Column

Required. A Variant.

One of the following:

  • The column name where the cell is located.
  • The column number where the cell is located. The first column in the table is numbered 1.
  • The column index where the cell is located. To specify the index of the column, use '#<index>'. Index values begin with 1.
CellText

Required. A String value.

The text in the cell you want to scroll to.

CellTextIndex

Optional. A long integer value.

An index number assigned to the cell you want to scroll to.

To specify the index of the column, use '#<index>'. Index values begin with 0.

ColumnIndex

Optional. A long integer value.

An index number assigned to the column that contains the cell you want to scroll to.

To specify the index of the column, use '#<index>'. Index values begin with 0.

Return Type

Integer, the row number

Example

Back to top

 

ScrollToRow Method

Description

Scrolls to a specified row, as defined by the row’s number.

Syntax

object.ScrollToRow (Row)

Arguments

ParameterDescription
Row

Required. Integer.

The row number. The first row in the table is numbered 1.

Return Type

Integer, the row number

Example

Back to top

 

SelectCell Method

Description

Selects the specified cell in the grid.

Syntax

object.SelectCell Row, Column

Arguments

ParameterDescription
Row

Required. A long integer value.

The row number where the cell is located. The first row in the table is numbered 1.

Column

Required. A Variant.

One of the following:

  • The column name where the cell is located.
  • The column number where the cell is located. The first column in the table is numbered 1.
  • The column index where the cell is located. To specify the index of the column, use '#<index>'. Index values begin with 1.

Return Type

None

Example

Back to top

RowCount Method

Description

Returns the number of rows in the table.

Syntax

object.RowCount

Return Type

A long integer value.

Example

Back to top

Submit Method

Description

Submits a form.

Syntax

object.Submit

Return Type

None.

IMPORTANT

This method simulates pressing the Enter key, while the focus is on the object specified in the statement.

If the object is not part of a Web form, the Submit method has no effect.

Back to top

 

Swipe Method

Description

Swipes the object.

Syntax

object.Swipe direction, [distance], [duration], [startX], [startY]

Arguments

ParameterDescription
direction Required. A MoveDirection Value.

The direction of the swipe gesture.

Possible values:

  • moveDown
  • moveLeft
  • moveRight
  • moveUp

 

distance Optional. A long integer value.
The distance (in pixels) of the swipe gesture.
Default value = 200
duration Optional. A double floating value.

The time period (in seconds) of the swipe gesture.

You can specify partial seconds as a duration time.


Default value = 0.25
startX Optional. A long integer value.
The x-coordinate at which the swipe gesture begins. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999
startY Optional. A long integer value.
The y-coordinate at which the swipe gesture begins. The coordinate is relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999

Return Type

None

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab (UFT Mobile) or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

This method is not supported on Windows Phone.

Example

Back to top


 

Verify Method

Description

Checks whether the specified property returns the specified value within the specified timeout.

Syntax

object.Verify (Text)

Arguments

ParameterDescription
Text Required. A String value. The text to enter in the text field.

Return Type

A Boolean value.


See also: