Object Model Reference for GUI Testing > SAP Web > ActivateCell Method

SAPTable Object

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

Method ActivateCell Double-clicks the cell specified by row and column.
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.
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 a cell.
Common Method ChildObjects Returns the collection of child objects contained within the object.
Method Click Clicks the object.
Method ColumnCount Return the number of columns in a specified row.
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 FindRowByCellContent Retrieves the first row of the cell in the given column whose content matches the specified data.
Method FireEvent Triggers an event.
Method GetCellData Returns the text for a specified cell.
Common Method GetROProperty Returns the current value of the description properties from the object in the application.
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.
Method OpenPossibleEntries Opens a list of possible entries for a specified cell.
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 a table.
Method SelectCell Clicks the item in the cell, if one exists.
Method SelectItemInCell Clicks the specified item in the specified cell.
Method SetCellData Sets the data of the cell specified by row and column.
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

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

ActivateCell Method

Description

Double-clicks the cell specified by row and column.

Syntax

object.ActivateCell Row, Column

Arguments

Parameter Description
Row Required. A long integer value.
Indicates the row number. The first row in the table is 1 (Note that if the table has a column header row, it is counted as the first row in the table.)
Column Required. A long integer value.
Indicates the column number. The first column in the table is 1.

Return Type

None

Example


 

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 1. (Note that if the table has a column header row, it is counted as the first row in the table.)
Column Required. A long integer value.
The column number where the cell is located. The first column in the table is 1.
MicClass Required. A String value.
The test object class.
Index Required. A long integer value.
Index of the object of the specified TO_Class in the cell. It is used to specify the desired element when there is more then one object of type TO_Class 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 a 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 1. (Note that if the table has a column header row, it is counted as the first row in the table.)
Column Required. A long integer value.
The column number where the cell is located. The first column in the table is 1.
MicClass Required. A String value.
The test object class.

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. Note that 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. Note that 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 = -9999
BUTTON Optional. A predefined constant or number.
The mouse button used to click the object.
Default value = micLeftBtn

Return Type

None

Example


 

Back to top

ColumnCount Method

Description

Return the number of columns in a specified row.

Syntax

object.ColumnCount (Row)

Arguments

Parameter Description
Row Required. A long integer value.
The row number for which you want to retrieve the column count. The first row in the table is 1. (Note that if the table has a column header row, it is counted as the first row in the table.)

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.

Default value = -9999
y Optional. A long integer value.

Default value = -9999
BUTTON Optional. A predefined constant or number.

Default value = micLeftBtn
Modifier Optional. A String value.

Default value = 0

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

Parameter Description
x Optional. A long integer value.

Default value = -9999
y Optional. A long integer value.

Default value = -9999

Return Type

None


 

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

Parameter Description
Col Required. A long integer value.
The column number in which to search for the specified string. The first column in the table is 1.
CellText Required. A String value.
The string for which to search.
StartFromRow Optional. A long integer value.
The row in which to begin the search. The default row is 1.
Default value = 1

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

Parameter Description
EventName Required. A String value.
The name of the event to trigger. All events exposed by the Dynamic HTML (DHTML) Object Model are supported. Refer to the DHTML Events section of the MSDN Library documentation for further information.
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.

Default value = micLeftBtn

Return Type

None

Example


 

Back to top

GetCellData Method

Description

Returns the text for a specified cell.

Syntax

object.GetCellData (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 1. (Note that if the table has a column header row, it is counted as the first row in the table.)
Column Required. A long integer value.
The column number where the cell is located. The first column in the table is 1.

Return Type

A String 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 Web site being tested is run on a mobile device on Mobile Center, 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


 

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


 

Back to top

OpenPossibleEntries Method

Description

Opens a list of possible entries for a specified cell.

Syntax

object.OpenPossibleEntries Row, Column

Arguments

Parameter Description
Row Required. A Variant.
The row number. The first row in the table is 1. (Note that if the table has a column header row, it is counted as the first row in the table.)
Column Required. A Variant.
The column number. The first column in the table is 1.

Return Type

None

IMPORTANT

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

Example


 

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 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 ot the upper left corner 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 Web site being tested is run on a mobile device on Mobile Center, 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


 

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 Web site being tested is run on a mobile device on Mobile Center, 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


 

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


 

Back to top

RowCount Method

Description

Returns the number of rows in a table.

Syntax

object.RowCount

Return Type

A long integer value.

Example


 

Back to top

SelectCell Method

Description

Clicks the item in the cell, if one exists.

Syntax

object.SelectCell Row, Column

Arguments

Parameter Description
Row Required. A long integer value.
The row number. The first row in the table is 1. (Note that if the table has a column header row, it is counted as the first row in the table.)
Column Required. A long integer value.
The column number. The first column in the table is 1.

Return Type

None

Example


 

Back to top

SelectItemInCell Method

Description

Clicks the specified item in the specified cell.

Syntax

object.SelectItemInCell Row, Column, [Item]

Arguments

Parameter Description
Row Required. A Variant.
The row number. The first row in the table is 1. (Note that if the table has a column header row, it is counted as the first row in the table.)
Column Required. A Variant.
The column number. The first column in the table is 1.
Item Optional. A String value.
The name of the item to select.
Default value = "#0"

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

Parameter Description
Row Required. A long integer value.
The row number. The first row in the table is 1. (Note that if the table has a column header row, it is counted as the first row in the table.)
Column Required. A long integer value.
The column number. The first column in the table is 1.
Data Required. A String value.
The data to be inserted in the specified cell.

Return Type

None

Example


 

Back to top

Submit Method

Description

Submits a form.

Syntax

object.Submit

Return Type

None.

Example


 

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

Example


Back to top

See also: