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

Common Method CaptureBitmapSaves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjectsReturns the collection of child objects contained within the object.
Common Method GetAllROProperties

Returns the collection of properties and current values from the object in the application.

Method ClickClicks the object.
Method DeselectClears a value from an SAP Gui for HTML multi-selection list.
Method DoubleClickClicks on the object twice.
Method DragPerforms the 'drag' part of a drag and drop operation.
Method DropPerforms the 'drop' part of a drag and drop operation.
Method ExtendSelectAdds selected items to an SAP Gui for HTML multi-selection list.
Method FireEventTriggers an event.
Method GetItemReturns the value of the item specified by the index.
Common Method GetROPropertyReturns the current value of the description property from the object in the application.
Common Method GetTOPropertiesReturns the collection of properties and values used to identify the object.
Common Method GetTOPropertyReturns the value of the specified description property from the test object description.
Common Method HighlightHighlights the object in the application.
Method HoverTapWhen hover is supported, places the pointer on the object. Otherwise, taps the object.
Method LongPressPresses and holds the object.
Method MiddleClickMiddle-clicks the object.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Method PanPerform a pan gesture.
Method PinchPerform a pinch gesture.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method RightClickRight-clicks the object.
Method SelectSelects a value from an SAP Gui for HTML list.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Method SubmitSubmits a form.
Method SwipeSwipes the object.
Common Method ToStringReturns a string that represents the test object.
Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property ExistChecks whether the object currently exists in the open application.
Common Property ObjectAccesses the native methods and properties of the object.

Back to top

 

Click Method

Description

Clicks the object.

Syntax

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

Arguments

ParameterDescription
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

 

Deselect Method

Description

Clears a value from an SAP Gui for HTML multi-selection list.

Syntax

object.Deselect Item

Arguments

ParameterDescription
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

Back to top

 

DoubleClick Method

Description

Clicks on the object twice.

Syntax

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

Arguments

ParameterDescription
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 UFT Mobile, 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

Back to top

 

Drag Method

Description

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

Syntax

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

Arguments

ParameterDescription
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

ParameterDescription
x Optional. A long integer value.

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

Default value = -9999

Return Type

None

Back to top

 

ExtendSelect Method

Description

Adds selected items to an SAP Gui for HTML multi-selection list.

Syntax

object.ExtendSelect Item

Arguments

ParameterDescription
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

Back to top

 

FireEvent Method

Description

Triggers an event.

Syntax

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

Arguments

ParameterDescription
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

 

GetItem Method

Description

Returns the value of the item specified by the index.

Syntax

object.GetItem (Index)

Arguments

ParameterDescription
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

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

ParameterDescription
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 UFT Mobile, 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

ParameterDescription
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 UFT Mobile 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

ParameterDescription
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

 

Pan Method

Description

Perform a pan gesture.

Syntax

object.Pan (deltaX, deltaY, [duration], [startX], [startY])

Arguments

ParameterDescription
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 UFT Mobile, 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

ParameterDescription
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 UFT Mobile, 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

ParameterDescription
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

 

Select Method

Description

Selects a value from an SAP Gui for HTML list.

Syntax

object.Select Item

Arguments

ParameterDescription
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

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

ParameterDescription
direction Required. A MoveDirection Value.

The direction of the swipe gesture.

Possible values:

  • moveDown
  • moveLeft
  • moveRight
  • moveUp
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 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 for Windows Phone.

Example

Back to top

See also: