SAPWebExtTable Object

Description

A table containing a variable number of rows and columns.

IMPORTANT

The SAPWebExtTable test object class extends the WebTable test 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 SAPWebExtTable object.

Note: You can also view a list and descriptions of the SAPWebExtTable 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

CaptureBitmap	Saves a screen capture of the object as a .png or .bmp image using the specified file name.
Cell	Returns a cell of type WebElement in the specified row and column.
Check	Checks whether the actual value of an item matches the expected value.
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.
ChildItem	Returns a test object from the cell by type and index.
ChildItemCount	Returns the number of objects of a specific type in the specified cell.
ChildObjects	Returns the collection of child objects contained within the object.
GetAllROProperties	Returns the collection of properties and current values from the object in the application.
Click	Clicks the object.
ColumnCount	Returns the number of columns in the table.
DeselectAll	Deselects all rows in the table.
DeselectRow	Clears the selection of the specified row.
DoubleClick	Clicks on the object twice.
Drag	Performs the 'drag' part of a drag and drop operation.
Drop	Performs the 'drop' part of a drag and drop operation.
FireEvent	Triggers an event.
GetCellData	Returns the text contained in the specified cell.
GetColumnName	Retrieves the name of the column with the specified index.
GetROProperty	Returns the current value of the description property from the object in the application.
GetRowWithCellText	Returns the number of the first row found that contains a cell with the specified text.
GetTOProperties	Returns the collection of properties and values used to identify the object.
GetTOProperty	Returns the value of the specified description property from the test object description.
Highlight	Highlights the object in the application.
HoverTap	When hover is supported, places the pointer on the object. Otherwise, taps the object.
LongPress	Presses and holds the object.
MiddleClick	Middle-clicks the object.
Output	Retrieves the current value of an item and stores it in a specified location.
Pan	Perform a pan gesture.
Pinch	Perform a pinch gesture.
RefreshObject	Instructs UFT One to re-identify the object in the application the next time a step refers to this object.
RightClick	Right-clicks the object.
RowCount	Returns the number of rows in the table.
SelectAll	Selects all of the rows in the table.
SelectRow	Selects the specified row in the table.
SetCellData	Sets the contents of a cell to the specified value.
SetTOProperty	Sets the value of the specified description property in the test object description.
Sort	Sorts the table.
Submit	Submits a form.
Swipe	Swipes the object.
ToString	Returns a string that represents the test object.
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.
Exist	Checks whether the object currently exists in the open application.
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

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

Return Type

An Object.

Example

Perform an Operation on an Edit Box Inside a Table (VBScript)

                    'The following example uses the ChildItem method to set the second
'edit box from the FirstName table to Example.

Set WebEditObj = Browser("Booking Site").Page("Method of Payment").SAPWebExtTable("FirstName").ChildItem(8, 2, "WebEdit", 0)
WebEditObj.Set "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

Return Type

A long integer value.

Example

Find the Number of Objects Contained in a Table (VBScript)

                    'The following example uses the ChildItemCount method to count
'the number of edit fields in a cell in the sample table.

Dim NumEdit
NumEdit = Browser("Booking Site").Page("Method of Payment").SAPWebExtTable("FirstName").ChildItemCount(1, 2, "WebEdit")

Back to top

Click Method

Description

Clicks the object.

Syntax

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

Arguments

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.

Back to top

ColumnCount Method

Description

Returns the number of columns in the table.

Syntax

object.ColumnCount (Row)

Arguments

Return Type

A long integer value.

Example

Find the Number of Columns in a Table (VBScript)

                    'The following example uses the ColumnCount method to determine the
'number of columns in the first row of the OutboundFlights table.

NumColumns = Browser("Booking Site").Page("Search Results").SAPWebExtTable("OutboundFlights").ColumnCount(1)
  MsgBox "The number of columns in the row is " & NumColumns

Back to top

DeselectRow Method

Clears the selection of the specified row.

Syntax

object.DeselectRow (Row)

Arguments

Return Type

A Boolean value.

Back to top

DeselectAll Method

Description

Deselects all rows in the table.

Syntax

object.DeselectAll

Return Type

None

Back to top

DoubleClick Method

Description

Clicks on the object twice.

Syntax

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

Arguments

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

Back to top

Drag Method

Description

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

Syntax

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

Arguments

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

Back to top

Drop Method

Description

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

Syntax

object.Drop [x], [y]

Arguments

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.

Back to top

FireEvent Method

Description

Triggers an event.

Syntax

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

Arguments

Return Type

None

Back to top

GetCellData Method

Description

Returns the text contained in the specified cell.

Syntax

object.GetCellData (Row, Column)

Arguments

Return Type

A String value.

Returns the data contained in the specified cell.

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

Back to top

GetColumnName Method

Description

Retrieves the name of the column with the specified index.

Syntax

object.GetCellData (Row, Column)

Arguments

Return Type

A String value.

Returns the name of the selected column.

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

Return Type

A long integer value.

Example

Find a Cell with Specified Text and Click It (VBScript)

                    'The following example uses the GetRowWithCellText method to
'find the row in the "OutboundFlights" table that contains the
'text "Price" and then find the cell in that row that contains
'a link and click it.

row = Browser("Booking Site").Page("Search Results").SAPWebExtTable("OutboundFlights").GetRowWithCellText("Price", 2, 2)
Set Link = Browser("Booking Site").Page("Search Results").SAPWebExtTable("OutboundFlights").ChildItem(row, 2, "Link", 0)
Link.Click

Find All Employees that Live in the Same City (VBScript)

                    Sub GetCellData_GetRowWithCellText_Example()
'The following example retrieves the names of all employees that live in
'the same city as John Smith so that he can arrange rides home with them.
'First, the example finds the table row containing
'"John Smith". Then it checks the value of the CityColumn cell to determine
'the city in which John lives. It searches the table cells to find all other
'employees that live in that city. Finally it uses the GetCellData method to
'return those employees names and, using a function, generates a list
'containing those names.

CityColumn = 4
NameColumn = 2
'Get the row number for employee 'John Smith'
RowNumber = Browser("CorporateEmployees").Page("CorporateEmployees").SAPWebExtTable("EmployeesTable").GetRowWithCellText("John Smith")
Set AccommodationsCity = Browser("CorporateEmployees").Page("CorporateEmployees").SAPWebExtTable("EmployeesTable").ChildItem(RowNumber, CityColumn, "WebEdit", 0)
TableRows = Browser("CorporateEmployees").Page("CorporateEmployees").SAPWebExtTable("EmployeesTable").RowCount
'Search for all employees that live in the same city as 'John Smith' and add them to his ride home list
For i = 1 To TableRows
    Set CurrentCity = Browser("CorporateEmployees").Page("CorporateEmployees").SAPWebExtTable("EmployeesTable").ChildItem(i, CityColumn, "WebEdit", 0)
    If CurrentCity.GetROProperty("value") = AccommodationsCity.GetROProperty("value") Then
        EmployeeName = Browser("CorporateEmployees").Page("CorporateEmployees").SAPWebExtTable("EmployeesTable").GetCellData(i, NameColumn)
       AddToJohnSmithRideHomeList (EmployeeName)
    End If
Next
End Sub

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

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

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

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

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

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

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

RowCount Method

Description

Returns the number of rows in the table.

Syntax

object.RowCount

Return Type

A long integer value.

Example

Find the Number of Rows in a Table (VBScript)

                    'The following example uses the RowCount method to determine the
'number of rows in the Outbound Flights table.

NumRows = Browser("Booking Site").Page("Search Results").SAPWebExtTable("OutboundFlights").RowCount
' NumRows contains 5

Back to top

SelectAll Method

Description

Selects all of the rows in the table.

Syntax

object.SelectAll

Return Type

None

Back to top

SelectRow Method

Description

Selects the specified row in the table.

Syntax

object.SelectRow (Row)

Arguments

Return Type

A Boolean value.

Back to top

SetCellData Method

Description

Sets the contents of a cell to the specified value.

Syntax

object.SetCellData Row, Column, Data

Arguments

Return Type

None

Back to top

Sort Method

Description

Sorts the table.

Syntax

object.Sort Column, Data

Arguments

IMPORTANT

When using this method on tables in Internet Explorer, sometimes an extra character is added to the header after sorting. Therefore subsequent sort operations will fail.

It is recommended to use the index for the column parameter instead.

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.

Back to top

Swipe Method

Description

Swipes the object.

Syntax

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

Arguments

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

Back to top

See also:

• SAPWebExt Calendar
• SAPWebExtCheckBox
• SAPWebExtList
• SAPWebExtMenu
• SAPWebExtRadioButton
• SAPWebExtTabStrip
• SAPWebExtTable