Description

Presses and holds the object.

IMPORTANT

Each cell in the table or grid can contain SAP Web or Web objects.

Operations

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

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

ActivateCell	Double-clicks the cell specified by row and column.
CaptureBitmap	Saves a screen capture of the object as a .png or .bmp image using the specified file name.
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.
ChildItem	Returns a test object from the cell by type and index.
ChildItemCount	Returns the number of objects of a specific type in a 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	Return the number of columns in a 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.
ExtendDeSelectRow Supported in UFT One 24.2 and later	Clears the selection of the specified row only.
ExtendSelectRow Supported in UFT One 24.2 and later	Selects the specified row in the table in addition to any rows already selected.
FindRowByCellContent	Retrieves the first row of the cell in the given column whose content matches the specified data.
FireEvent	Triggers an event.
GetCellData	Returns the text for a specified cell.
GetCellDataEx	Returns a cell's content from a row with specific content in another cell.
GetROProperty	Returns the current value of the description property from the object in the application.
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.
OpenPossibleEntries	Opens a list of possible entries for a specified cell.
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 a table.
SelectCell	Clicks the item in the cell, if one exists.
SelectItemInCell	Clicks the specified item in the specified cell.
SetCellData	Sets the data of the cell specified by row and column.
SetTOProperty	Sets the value of the specified description property in the test object description.
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

Exist	Checks whether the object currently exists in the open application.
Object	Accesses the native methods and properties of the object.

Back to top

ActivateCell Method

Description

Double-clicks the cell specified by row and column.

Syntax

object.ActivateCell Row, Column

Arguments

Return Type

None

Example

Double-Click an Object in a Table Cell (VBScript)

'The following example uses the ActivateCell method to double-click the object in the cell
'in the 5th row and 4th column in the "1x1" SAP table.
Browser("ITS System Informati").Page("Table control").SAPTable("1x1").ActivateCell 5, 4

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

Set the Text for an Edit Box in a Table Cell (VBScript)

                    'The following example uses the ChildItem method to set the first edit box in the cell in
'the 5th row, 4th column in the "1x1" table to "sometext".

                    Dim SAPEdit
Set SAPEdit = Browser("ITS System Informati").Page("Table control").SAPTable("1x1").ChildItem(5, 4, "SapEdit", 0)
SAPEdit.Set "sometext"

Back to top

ChildItemCount Method

Description

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

Syntax

object.ChildItemCount (Row, Column, MicClass)

Arguments

Return Type

A long integer value.

Example

Count the Number of Items in a Table Cell (VBScript)

                    'The following example uses the ChildItemCount method to count the number of edit boxes in
'a cell in the "1x1" table.

                    Dim NumEdits
Set NumEdits = Browser("ITS System Informati").Page("Table control").SAPTable("1x1").ChildItemCount(5, 4, "SapEdit")

Back to top

Click Method

Description

Clicks the object.

Syntax

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

Arguments

Return Type

None

Example

Click an Edit Box (VBScript)

                    'The following example uses the Click method on the "Manufacturer" edit box.
Browser("ITS System Informati").Page("User Interface_7").SAPEdit("Manufacturer").Click

Click a Specific Button (VBScript)

                    'The following example uses the Click method to click the "SAP Business" button
'in the "SAPGUI for HTML" page.
Browser("SAPGUI for HTML").Page("SAPGUI for HTML").SAPFrame("SAP Easy Access").SAPButton("SAP Business").Click

Back to top

ColumnCount Method

Description

Return the number of columns in a specified row.

Syntax

object.ColumnCount (Row)

Arguments

Return Type

A long integer value.

Example

Count the Number of Columns in a Table (VBScript)

                    'The following example uses the ColumnCount method to determine the number of columns in
'the fifth row of the "1x1" table.
NumCols = Browser("ITS System Informati").Page("Table control").SAPTable("1x1").ColumnCount(5)

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 Web site being tested is run on a mobile device on Digital Lab, and the test object implements this gesture. 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

Double-click a Specific Button (VBScript)

                    'The following example uses the DoubleClick method to click the "SAP Business" button
'in the "SAPGUI for HTML" page.
Browser("SAPGUI for HTML").Page("SAPGUI for HTML").SAPFrame("SAP Easy Access").SAPButton("SAP Business").DoubleClick

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

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

Back to top

ExtendDeSelectRow Method

Supported in UFT One 24.2 and later

Description

Clears the selection of the specified row only.

Syntax

object.ExtendDeSelectRow (Row)

Arguments

Return Type

A Boolean value.

IMPORTANT

This method is relevant only for table controls that support selecting multiple rows.

Example

Deselect a row in a Multi-Select Table (VBScript)

'The following example deselects a row in a multi-select table, leaving any other row selections unchanged.
Browser("SAP R/3 System").Page("SAP R/3 System").SAPFrame("SAP R/3 System").SAPTable("Title of the Table").ExtendDeSelectRow 36

Back to top

ExtendSelectRow Method

Supported in UFT One 24.2 and later

Description

Selects the specified row in the table in addition to any rows already selected.

Syntax

object.ExtendSelectRow (Row)

Arguments

Return Type

A Boolean value.

IMPORTANT

This method is relevant only for table controls that support selecting multiple rows.

You can use this method to select a row also if no other rows are selected.

Example

Select an Additional Row in a Multi-Select Table (VBScript)

'The following example selects an additional row in a multi-select table.
Browser("SAP R/3 System").Page("SAP R/3 System").SAPFrame("SAP R/3 System").SAPTable("Title of the Table").ExtendSelectRow 39

Back to top

FindRowByCellContent Method

Description

Retrieves the first row of the cell in the given column whose content matches the specified data.

Syntax

object.FindRowByCellContent (Col, CellText, [StartFromRow])

Arguments

Return Type

A long integer value.

If no content matches the specified value, the return value is NULL.

IMPORTANT

If the browser is exposed to only the visible rows, only these rows will be included in the search.

Back to top

FireEvent Method

Description

Triggers an event.

Syntax

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

Arguments

Return Type

None

Example

Simulate an Event on a Button (VBScript)

'The following example uses the FireEvent method to simulate the "onmouseover" event
'on the "Tools" button.
Browser("SAP R/3 System").Page("SAP R/3 System").SAPFrame("SAP R/3 System").SAPButton("Tools").FireEvent "onmouseover"

Back to top

GetCellData Method

Description

Returns the text for a specified cell.

Syntax

object.GetCellData (Row, Column)

Arguments

Return Type

A String value.

Example

Retrieve the Contents of a Table Cell (VBScript)

                    'The following example uses the GetCellData method to retrieve the contents of the cell
'located in row 5, column 4

                    Dim Info
Set Info = Browser("ITS System Informati").Page("Table control").SAPTable("1x1").GetCellData(5, 4)

Back to top

GetCellDataEx Method

Description

Returns a cell's content from a row with specific content in another cell.

This method performs the equivalent of FindRowByCellContent and GetCellData, retrieving the content of the specified column from the first row found with the specified content.

Syntax

object.GetCellDataEx (Column, ByColumn, ByValue, [StartFromRow])

Arguments

Return Type

A String value.

Example

Retrieve the Contents of a Table Cell Based on the Content of Another (VBScript)

'The following example uses the GetCellDataEx method to retrieve the contents of the cell
'in column 1 from a row with "collapsedPlus" in column 2, starting from row 3.
'Note that if there are several rows that match the search criteria, 
'UFT One retrieves cell content in the first row that matches the criteria.
cellcontent=Browser("Test of Input Behavior").Page("SAPTable").SAPTable("Change Status").GetCellDataEx(1,2,"collapsedPlus",3)
If cellcontent="TreeElement 7" Then
    Reporter.ReportEvent micPass, "GetCellDataEx start from", "Passed"
    else
    Reporter.ReportEvent micFail, "GetCellDataEx start from", "Didn't find, cellcontent is "&cellcontent&", expected TreeElement 7"
End If			

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 Web site being tested is run on a mobile device on Digital Lab, and the test object implements this gesture. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

Example

Hover Over or Tap a WebElement (VBScript)

The following example uses the HoverTap method on a form.
'When hover is supported, such as on a desktop, a hover action is performed. 
'When hover is not supported, such as on a mobile device, a tap is performed instead.

Browser("New Page").Page("New Page").WebElement("html tag:=Form").HoverTap

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

Back to top

OpenPossibleEntries Method

Description

Opens a list of possible entries for a specified cell.

Syntax

object.OpenPossibleEntries Row, Column

Arguments

Return Type

None

IMPORTANT

This method can be performed only on edit fields within table objects.

Example

Open the Possible Entries List or Dialog Box (VBScript)

'The following example uses the OpenPossibleEntries method to open the "Possible Entries" list or dialog box
'for the cell in the second row and third column of the "Purchase Details" table.
Browser("Browser").Page("SAP Enterprise_12").SAPFrame("Create Purchase").SAPTable("Purchase Details").OpenPossibleEntries 2, 3

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 Web site being tested is run on a mobile device on Digital Lab, and the test object implements this gesture. 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

Pan across a SAPTable element (VBScript)

'The following example performs a Pan gesture on a SAPTable object.

Browser("ITS System Informati").Page("Table control").SAPTable("1x1").Pan 564, 507

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 Web site being tested is run on a mobile device on Digital Lab, and the test object implements this gesture. 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

Pinch a SAPTable object (VBScript)

'The following example performs a Pinch gesture to zoom in on a SAPTable object.

Browser("ITS System Informati").Page("Table control").SAPTable("1x1").Pinch 2.5

Back to top

RightClick Method

Description

Right-clicks the object.

Syntax

object.RightClick [x], [y]

Arguments

Return Type

None

Back to top

RowCount Method

Description

Returns the number of rows in a table.

Syntax

object.RowCount

Return Type

A long integer value.

Example

Count the Number of Rows in a Table (VBScript)

'The following example uses the RowCount method to determine the number of rows in the "1x1" table.
NumRows = Browser("ITS System Informati").Page("Table control").SAPTable("1x1").RowCount

Back to top

SelectCell Method

Description

Clicks the item in the cell, if one exists.

Syntax

object.SelectCell Row, Column

Arguments

Return Type

None

Example

Select a Specific Cell in a Table (VBScript)

'The following example uses the SelectCell method to click the object in the cell in the
'5th row, 4th column of the "1x1" table.
Browser("ITS System Informati").Page("Table control").SAPTable("1x1").SelectCell 5, 4

Back to top

SelectItemInCell Method

Description

Clicks the specified item in the specified cell.

Syntax

object.SelectItemInCell Row, Column, [Item]

Arguments

Return Type

None

Back to top

SetCellData Method

Description

Sets the data of the cell specified by row and column.

Syntax

object.SetCellData Row, Column, Data

Arguments

Return Type

None

Example

Set the Data of a Specific Cell in a Table (VBScript)

'The following example uses the SetCellData method to set the data in the cell in the
'5th row, 4th column of the "1x1" table to "Paris".
Browser("ITS System Informati").Page("Table control").SAPTable("1x1").SetCellData 5, 4, "PARIS"

Back to top

Submit Method

Description

Submits a form.

Syntax

object.Submit

Return Type

None.

Example

Submit a Form Using a Specific Edit Box (VBScript)

'The following example uses the Submit method to submit a form using the "Manufacturer" edit box.
Browser("ITS System Informati").Page("User Interface_7").SAPEdit("Manufacturer").Submit

Submit a Form (VBScript)

'The following example uses the Submit method to submit a form using the "Manufacturer" button.
Browser("ITS System Informati").Page("User Interface_7").SAPButton("Manufacturer").Submit

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 for Windows Phone.

Example

Swipe a Table Object (VBScript)

'The following example performs a Swipe gesture on a SAPTable object.

Browser("ITS System Informati").Page("Table control").SAPTable("1x1").Swipe moveDown,200,1,75,75

Back to top

See also:

• SAPButton
• SAPCalendar
• SAPCheckBox
• SAPDropDownMenu
• SAPEdit
• SAPFrame
• SAPiView
• SAPList
• SAPMenu
• SAPNavigationBar
• SAPNWBC
• SAPOKCode
• SAPPortal
• SAPRadioGroup
• SAPStatusBar
• SAPTable
• SAPTabStrip
• SAPTreeView