Object Model Reference for GUI Testing > SAPWDJ > ChildItem Method

SAPWDJTable Object

Description

A SAPWdj Table control.

IMPORTANT

The SAPWDJTable test object class extends the WebTabletest object class and inherits many of its operations and description properties.

Operations

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

Note: You can also view a list and descriptions of the SAPWDJTable 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, depending on the specified file extension.
Common Method Check Checks whether the actual value of an item matches the expected value.
Common Method CheckProperty Checks whether the specified object property achieves the specified 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 ExtendDeselectRow Extends Deselects the specified cell in the table.
Method ExtendSelectRow Extends Selects the specified cell in the table.
Method FireEvent Triggers an event.
Method GetCellData Retrieves the contents of the specified cell.
Method GetItemIndexInCell get an item index
Common Method GetROProperty Returns the current value of the specified 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.
Method SelectCell Retrieves the contents of the specified cell.
Method SelectItemInCell Selects the specified item in the specified cell. Item might be text or string index
Method SelectRow Selects the specified row in the table.
Method SetCellData Sets the contents of a cell to the specified value.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Method Sort Sorts the table.
Method Submit Submits a form.
Method Swipe Swipes the object.
Common Method ToString Returns a string that represents the current 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

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

 

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. An integer value.
The row number where the cell is located. The first row in the table is numbered 1.
Column Required. An 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. An integer value.
The index of the object of type MicClass in the cell. This index indicates the desired element when there is more than 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. An integer value.
The row number where the cell is located. The first row in the table is numbered 1.
Column Required. An 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

An integer value.

Example

Back to top

 

Click Method

Description

Clicks the object.

Syntax

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

Arguments

Parameter Description
x Optional. An 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 = 0
y Optional. An 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.

Tip: You can enter MicNoCoordinate for the x and y argument values if you want to enter a value for the button argument without specifying x- and y-coordinates for the click.


Default value = 0
BUTTON Optional. A predefined constant or number.
The mouse button used to click the object.
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. An integer value.
The row number. The first row in the table is numbered 1.

Return Type

An 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 Variant.
The number of seconds between the two clicks. The default value is 0.2 seconds.
x Optional. An 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 = 0
y Optional. An 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 = 0

Return Type

None

IMPORTANT

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. An integer value.
The x-coordinate within the source object.
Default value = 0
y Optional. An integer value.
The y-coordinate within the source object.
Default value = 0
BUTTON Optional. A predefined constant or number.
The mouse button used to drag the object. (Releasing the button performs the Drop operation.)
Default value = micLeftBtn
Modifier Optional. A String value.

The keyboard modifier that is pressed during the Drag operation.

Possible values:

  • micAlt
  • micCtrl
  • micShift

Return Type

None

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. An 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 value = 0
y Optional. An 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 value = 0

Return Type

None

IMPORTANT

Example

Back to top

 

ExtendDeselectRow Method

Description

Extends Deselects the specified cell in the table.

Syntax

object.ExtendDeselectRow Row

Arguments

Parameter Description
Row Required. An integer value.
The row to clear. The first row in the table is numbered 1.

Return Type

None

Example

Back to top

 

ExtendSelectRow Method

Description

Extends Selects the specified cell in the table.

Syntax

object.ExtendSelectRow Row

Arguments

Parameter Description
Row Required. An integer value.
The row to add to the already selected rows. The first row in the table is numbered 1.

Return Type

None

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 the event to trigger. Available events: onchange, onclick, ondblclick, onblur, onfocus, onmousedown, onmouseup, onmouseover, onmouseout, onsubmit, onreset, onpropertychange.
x Optional. An integer value.
The x-coordinate, relative to the upper left corner of the object.
Default value = 0
y Optional. An integer value.
The y-coordinate, relative to the upper left corner of the object.
Default value = 0
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

Retrieves the contents of the specified cell.

Syntax

object.GetCellData (Row, Column)

Arguments

Parameter Description
Row Required. An integer value.
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 micFail.

Example

Back to top

 

GetItemIndexInCell Method

Description

get an item index

Syntax

object.GetItemIndexInCell Row, Col, Key

Arguments

Parameter Description
Row Required. An integer value.
Col Required. An integer value.
Key Required. A Variant.

Return Type

None

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.
StartFromRow Optional. An integer value.
The number of the row in which to start the seach. The first row in the table is numbered 1.
Default value = 0

Return Type

An 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. An 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 = 0
y Optional. An 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 = 0

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

 

LongPress Method

Description

Presses and holds the object.

Syntax

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

Arguments

Parameter Description
duration Optional. A Variant.

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

You can specify partial seconds as a duration time.

x Optional. An integer value.
The x-coordinate of the long 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 = 0
y Optional. An 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 = 0

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

 

MiddleClick Method

Description

Middle-clicks the object.

Syntax

object.MiddleClick [x], [y]

Arguments

Parameter Description
x Optional. An 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 = 0
y Optional. An integer value.
The y-coordintae of the middle-clic, The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0

Return Type

None

IMPORTANT

Example

Back to top

 

Pan Method

Description

Perform a pan gesture.

Syntax

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

Arguments

Parameter Description
deltaX Required. An integer value.
The distance moved on the x axis, relative to the start point.
deltaY Required. An integer value.
The distance moved on the y axis, relative to the start point.
duration Optional. A Variant.
The number of seconds required to peform the pan gesture.
startX Optional. An 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 = 0
startY Optional. An 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 = 0

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.

Back to top

 

Pinch Method

Description

Perform a pinch gesture.

Syntax

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

Arguments

Parameter Description
scale Required. A Variant.

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 Variant.
The number of seconds required to perform the pinch gesture. The default value is 1 second.
x Optional. An 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 = 0
y Optional. An integer value.
The y-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 = 0

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.

Back to top

 

RightClick Method

Description

Right-clicks the object.

Syntax

object.RightClick [x], [y]

Arguments

Parameter Description
x Optional. An 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 = 0
y Optional. An 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 objet.
Default value = 0

Return Type

None

IMPORTANT

Example

Back to top

 

RowCount Method

Description

Returns the number of rows in the table.

Syntax

object.RowCount

Return Type

An integer value.

IMPORTANT

This method returns the number of visible rows, regardless of the total number of rows in the table.

Example

Back to top

 

SelectCell Method

Description

Retrieves the contents of the specified cell.

Syntax

object.SelectCell Row, Column

Arguments

Parameter Description
Row Required. An integer value.
The row number. The first row in the table is 1.
Column Required. A Variant.

The name (with quotes) or number (without quotes) of the column in which the cell is located.

The first column in the table is 1.

To specify a column number, use the number, or the format "#N", where N is the numeric value.

Return Type

None

Example

Back to top

 

SelectItemInCell Method

Description

Selects the specified item in the specified cell. Item might be text or string index

Syntax

object.SelectItemInCell Row, Column, [Item]

Arguments

Parameter Description
Row Required. An integer value.
The row number. The first row in the table is 1.
Column Required. A Variant.

The name (with quotes) or number (without quotes) of the column in which the cell is located.

The first column in the table is 1.

To specify a column number, use the number, or the format "#N", where N is the numeric value.

Item Optional. A String value.

The item (in quotes) to select in the cell.

If you are working with a table containing expandable or selectable tree nodes, you must enter one of the following arguments:

  • Check
  • Uncheck
  • Expand
  • Collapse

The following indexes also can be used to change the status of expandable or selectable tree nodes:

  • "#1" - Expand or collapse the node
  • "#2" - check or uncheck the node (if a checkbox exists)

Return Type

None

Example

Back to top

 

SelectRow Method

Description

Selects the specified row in the table.

Syntax

object.SelectRow Row

Arguments

Parameter Description
Row Required. An integer value.

The numeric index of the row you want to select. Index values begin with 1.

The first row containing data is the row 1, and header rows are ignored.

Return Type

None

IMPORTANT

Example

Back to top

 

SetCellData Method

Description

Sets the contents of a cell to the specified value.

Syntax

object.SetCellData Row, Column, Data

Arguments

Parameter Description
Row Required. An integer value.
The row number. The first row in the table is 1.
Column Required. A Variant.

The name (with quotes) or number (without quotes) of the column in which the cell is located.

The first column in the table is 1.

To specify a column number, use the number, or the format "#N", where N is the numeric value.

Data Required. A String value.
The data to be inserted in the specified cell.

Return Type

None

Example

Back to top

 

Sort Method

Description

Sorts the table.

Syntax

object.Sort Column

Arguments

Parameter Description
Column Required. A Variant.

The name (with quotes) or number (without quotes) of the column.

The first column in the table is 1.

To specify a column number, use the number, or the format "#N", where N is the numeric value.

Return Type

None

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

Parameter Description
direction Required. A MoveDirection Value.

The direction of the swipe gesture.

Possible values:

  • moveDown
  • moveLeft
  • moveRight
  • moveUp
distance Optional. An integer value.
The distance (in pixels) of the swipe gesture.
Default value = 0
duration Optional. A Variant.

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

You can specify partial seconds as a duration time.

startX Optional. An 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 = 0
startY Optional. An 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 = 0

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: