Share this page
SAPList Object
Description
A drop-down or single/multiple selection list in an SAP Gui for HTML application.
Operations
The sections below list the built-in methods and properties that you can use as operations for the SAPList object.
Note: You can also view a list and descriptions of the SAPList 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. |
| 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. |
| 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. |
| Deselect | Clears a value from an SAP Gui for HTML multi-selection list. |
| 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. |
| ExtendSelect | Adds selected items to an SAP Gui for HTML multi-selection list. |
| FireEvent | Triggers an event. |
| GetItem | Returns the value of the item specified by the index. |
| 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. |
| 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. |
| Select | Selects a value from an SAP Gui for HTML list. |
| 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. |
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
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").ClickClick 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
Deselect Method
Description
Clears a value from an SAP Gui for HTML multi-selection list.
Syntax
object.Deselect Item
Arguments
| Parameter | Description |
|---|---|
| Item |
Required. A Variant. Value to clear. The value can either be one of the items in the list or an index. To specify the index of the item to clear, use the format: #index. Index values begin with 0. |
Return Type
None
Example
Deselect a Named Item from the List (VBScript)
'The following example uses the Deselect method to deselect French from a list of languages.
Browser("ITS System Informati").Page("User Interface_19").SAPList("Language").Deselect "French"Deselect a Numbered Item from the List (VBScript)
'The following example uses the Deselect method to deselect the fifth item from a list.
Browser("ITS System Informati").Page("User Interface_19").SAPList("Language").Deselect "#4"
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. |
| 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
- 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
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
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
ExtendSelect Method
Description
Adds selected items to an SAP Gui for HTML multi-selection list.
Syntax
object.ExtendSelect Item
Arguments
| Parameter | Description |
|---|---|
| Item |
Required. A Variant. Item to select in addition to any selected items. The item can either be one of the items in the list or its index. To specify the index of the item to select, use the format: #index. Index values begin with 0. |
Return Type
None
Example
Add an Item to a List (VBScript)
'The following example uses the ExtendSelect method to add French to the selected languages in a list
'after English is selected.
Browser("ITS System Informati").Page("User Interface_19").SAPList("Language").Select "English"
Browser("ITS System Informati").Page("User Interface_19").SAPList("Language").ExtendSelect "French"
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
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"
GetItem Method
Description
Returns the value of the item specified by the index.
Syntax
object.GetItem (Index)
Arguments
| Parameter | Description |
|---|---|
| Index |
Required. A Variant. Numeric index of the item. Index values begin with 0. |
Return Type
A String value.
IMPORTANT
This method is not recorded. To add this method to your test, use the Step Generator or enter it manually in the Keyword View or Editor. For more information, refer to the UFT One User Guide.
Example
Get the Value of a Specific Item on the List (VBScript)
'The following example uses the GetItem method to return the value of the second item in the list.
itemVal = Browser("ITS System Informati").Page("User Interface_19").SAPList("Language").GetItem(1)
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 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
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 Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
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
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 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
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 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
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
Select Method
Description
Selects a value from an SAP Gui for HTML list.
Syntax
object.Select Item
Arguments
| Parameter | Description |
|---|---|
| Item |
Required. A Variant. Value to select. The value can either be one of the items in the list or an index. To specify the index of the item to select, use the format: #index.
Index values begin with 0.
|
Return Type
None
IMPORTANT
If previous selections exist, they are replaced by the specified selection(s).
Note: If you want to add a selection to existing selections, use the ExtendSelect method.
Example
Select an Item on the List (VBScript)
'The following example uses the Select method to select English from a list of languages.
Browser("ITS System Informati").Page("User Interface_19").SAPList("Language").Select "English"
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").SubmitSubmit 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
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. 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 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 List Object (VBScript)
'The following example performs a Swipe gesture on a SAPList object.
Browser("ITS System Informati").Page("User Interface_19").SAPList("Language").Swipe moveDown,200,1,75,75
See also:
