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
CaptureBitmap | Saves a screen capture of the object as a .png or .bmp image, depending on the specified file extension. |
Check | Checks whether the actual value of an item matches the expected value. |
CheckProperty | Checks whether the specified object property achieves the specified 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. |
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 | Extends Deselects the specified cell in the table. |
ExtendSelectRow | Extends Selects the specified cell in the table. |
FireEvent | Triggers an event. |
GetCellData | Retrieves the contents of the specified cell. |
GetItemIndexInCell | get an item index |
GetROProperty | Returns the current value of the specified 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. |
SelectCell | Retrieves the contents of the specified cell. |
SelectItemInCell | Selects the specified item in the specified cell. Item might be text or string index |
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 current 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. |
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
'The following example returns an item from inside a cell in a SAPWDJTable object. Browser("ALVSimpleExt").Page("ALVSimpleExt").SAPWDJTable("ALVSimpleExt").ChildItem 1,1,"Button",1
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
'The following example returns all objects of type "Button" from a SAPWDJTable object. Browser("ALVSimpleExt").Page("ALVSimpleExt").SAPWDJTable("ALVSimpleExt").ChildItemCount 1,1,"Button"
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
- UFT One does not record the Click method for right- or middle-clicks. Instead, UFT One records the RightClick and MiddleClick methods.
- Recording options for this method are defined in the Web > Advanced tab of the Options dialog box (Tools > Options > GUI Testing tab > Web > Advanced node). For details, see the section on the Web > Advanced pane in the UFT One Add-ins Guide.
- For some Mozilla Firefox objects, this method is recorded only if a handler is present.
Example
'The following example clicks an SAPWDJMenu object. Browser("Service Registry").Page("Service Registry").SAPWDJMenu("Service Registry").Click 75,75
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
'The following example retrieves the number of columns in a SAPWDJTable object. Browser("ALVSimpleExt").Page("ALVSimpleExt").SAPWDJTable("ALVSimpleExt").ColumnCount 1
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
This method is supported as long as the application supports touch events and is run on a mobile device on UFT Mobile 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.
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:
|
Return Type
None
Example
'The following example drags an SAPWDJMenu object. Browser("Service Registry").Page("Service Registry").SAPWDJMenu("Service Registry").Drag 75,75s
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
- Drag and Drop operations are performed as a coupled step. Inserting one operation without the other causes an error to occur. For more details on Drag and Drop operations, see Drag Method.
- This test object method is not supported on Safari browsers.
Example
'The following example drops a dragged SAPWDJMenu object. Browser("Service Registry").Page("Service Registry").SAPWDJMenu("Service Registry").Drop 90,100
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
'The following example deselects a row from a SAPWDJTable object. Browser("ALVSimpleExt").Page("ALVSimpleExt").SAPWDJTable("ALVSimpleExt").ExtendDeselectRow 1
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
'The following example selects an additional row for a group of rows already selected 'in a SAPWDJTable object. Browser("ALVSimpleExt").Page("ALVSimpleExt").SAPWDJTable("ALVSimpleExt").ExtendSelectRow 1
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
'The following example fires the onclick event for a SAPWDJMenu object. Browser("Service Registry").Page("Service Registry").SAPWDJMenu("Service Registry").FireEvent "onclick"
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
'The following example retrieves the data from a specific cell in a 'SAPWDJ Table object. Dim txt txt = Browser("ALVSimpleExt").Page("ALVSimpleExt").SAPWDJTable("SAPWDJTable").GetCellData(1,1) print txt
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
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
'The following example finds the first row containing specific text in a SAPWDJTable object. Browser("ALVSimpleExt").Page("ALVSimpleExt").SAPWDJTable("ALVSimpleExt").GetRowWithCellText "Order"
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 UFT Mobile or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
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 UFT Mobile or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
Example
'The following example performs a LongPress on a SAPWDJTable object. Device("Device").App("HPE Mobile Web_2").MobileWebView("Web View").Page("Checkbox and radio inputs").SAPWDJTable("ALVSimpleExt").LongPress 1,75,75
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
- 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 Event Recording Configuration dialog box in the UFT One Add-ins Guide.
- When Event Replayis selected for the Replay type option in the Web > Advanced pane of the Options dialog box (Tools > Options > GUI Testing tab > Web > Advanced node), UFT One fires onmousedown, onfocus, 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.
Example
'The following example clicks the middle mouse button on a SAPWDJMenu object. Browser("Service Registry").Page("Service Registry").SAPWDJMenu("Service Registry").MiddleClick
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 UFT Mobile 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.
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 UFT Mobile 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.
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
- 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 Event Recording Configuration dialog box in the UFT One Add-ins Guide.
- When Event Replay is selected for the Replay type option in the Web > Advanced pane of the Options dialog box (Tools > Options > GUI Testing tab > Web > Advanced node), UFT One fires onmousedown, onfocus, 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.
Example
'The following example displays the context menu for a SAPWDJMenu object. Browser("Service Registry").Page("Service Registry").SAPWDJMenu("Service Registry").RightClick
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
'The following example returns the total number of rows in a SAPWDJTable object. Dim obj obj = Browser("ALVSimpleExt").Page("ALVSimpleExt").SAPWDJTable("SAPWDJTable").RowCount print obj
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
'The following example selects a cell in a SAPWDJTable object. Browser("ALVSimpleExt").Page("ALVSimpleExt").SAPWDJTable("ALVSimpleExt").SelectCell 1,1
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:
The following indexes also can be used to change the status of expandable or selectable tree nodes:
|
Return Type
None
Example
'The following example selects a link item in a table cell in a SAPWDJTable object. Browser("ALVSimpleExt").Page("ALVSimpleExt").SAPWDJTable("ALVSimpleExt").SelectItemInCell 1,1,"Transaction"
'The following example selects a button item in a table cell in a SAPWDJTable object. Browser("ALVSimpleExt").Page("ALVSimpleExt").SAPWDJTable("ALVSimpleExt").SelectItemInCell 1,1,"TEXT#6"
'The following example expands a tree inside a SAPWDJTable cell. Browser("CRConfigurations").Page("CRConfigurations").SAPWDJTable("SAPWDJTable").SelectItemInCell 1,1,"Expand"
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
- This method is not supported for running tests on Mozilla Firefox.
- This method is sometimes not recorded.
Example
'The following example selects a row from a SAPWDJTable object. Browser("ALVSimpleExt").Page("ALVSimpleExt").SAPWDJTable("ALVSimpleExt").SelectRow 1
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
'The following example sets the value of a table cell in a SAPWDJTable object. Browser("ALVSimpleExt").Page("ALVSimpleExt").SAPWDJTable("ALVSimpleExt").SetCellData 1,1,"Finished"
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
'The following example clicks on a column header to sort the column in a SAPWDJ object. Browser("ALVSimpleExt").Page("ALVSimpleExt").SAPWDJTable("ALVSimpleExt").Sort "#1"
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.
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:
|
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 UFT Mobile 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
'The following example performs a swipe gesture on a SAPWDJTable object. Device("Device").App("HPE Mobile Web_2").MobileWebView("Web View").Page("Checkbox and radio inputs").SAPWDJTable("ALVSimpleExt").Swipe moveDown,200,1,75,75
See also: