Object Model Reference for GUI Testing > Web > ChildItem Method

WebTable Object

Description

A table containing a variable number of rows and columns.

IMPORTANT

Operations

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

Note: You can also view a list and descriptions of the WebTable 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 CaptureBitmap Saves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method Check Checks whether the actual value of an item matches the expected value.
Common Method CheckProperty Checks 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.
Method ChildItem Returns a test object from the cell by type and index.
Method ChildItemCount Returns the number of objects of a specific type in the specified cell.
Common Method ChildObjects Returns the collection of child objects contained within the object.
Method Click Clicks the object.
Method ColumnCount Returns the number of columns in the table.
Method DoubleClick Clicks on the object twice.
Method Drag Performs the 'drag' part of a drag and drop operation.
Method Drop Performs the 'drop' part of a drag and drop operation.
Method FireEvent Triggers an event.
Method GetCellData Returns the text contained in the specified cell.
Common Method GetROProperty Returns the current value of the description properties from the object in the application.
Method GetRowWithCellText Returns the number of the first row found that contains a cell with the specified text.
Common Method GetTOProperties Returns the collection of properties and values used to identify the object.
Common Method GetTOProperty Returns the value of the specified description properties from the test object description.
Method HoverTap When hover is supported, places the pointer on the object. Otherwise, taps the object.
Method LongPress Presses and holds the object.
Method MiddleClick Middle-clicks the object.
Common Method Output Retrieves the current value of an item and stores it in a specified location.
Method Pan Perform a pan gesture.
Method Pinch Perform a pinch gesture.
Common Method RefreshObject Instructs UFT to re-identify the object in the application the next time a step refers to this object.
Method RightClick Right-clicks the object.
Method RowCount Returns the number of rows in the table.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Method Submit Submits a form.
Method Swipe Swipes the object.
Common Method ToString Returns a string that represents the test object.
Common Method WaitProperty Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Cell Returns a cell of type WebElement in the specified row and column.
Common Property Exist Checks whether the object currently exists in the open application.
Common Property Object Accesses 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

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

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

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

Parameter Description
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 does not record the Click method for right- or middle-clicks. Instead, UFT records the RightClick and MiddleClick methods.


Default value = micLeftBtn

Return Type

None

IMPORTANT

Example


 

Back to top

ColumnCount Method

Description

Returns the number of columns in the table.

Syntax

object.ColumnCount (Row)

Arguments

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

Parameter Description
interval Optional. A double floating value.
The number of seconds between the two clicks. The default value is 0.2 seconds.
Default value = 0.200000002980232
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

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

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

UFT supports the following scenarios:

General Note:

UFT 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 supports scrolling when the Drag and Drop test objects are both located in the same frame. UFT 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 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 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

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

Example


 

Back to top

FireEvent Method

Description

Triggers an event.

Syntax

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

Arguments

Parameter Description
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 text contained in the specified cell.

Syntax

object.GetCellData (Row, Column)

Arguments

Parameter Description
Row Required. A Variant.
The row number where the cell is located. The first row in the table is numbered 1.
Column Required. A Variant.
The column number where the cell is located. The first column in the table is numbered 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

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

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

Parameter Description
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 Mobile Center 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

Parameter Description
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 Mobile Center 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

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


 

Back to top

Pan Method

Description

Perform a pan gesture.

Syntax

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

Arguments

Parameter Description
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 peform 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 Mobile Center 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

Parameter Description
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 Mobile Center 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

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


 

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

See also: