Description

A drop-down box or multiple selection list.

IMPORTANT

• When learning or spying on WebList objects, if the list contains an empty value (""), then the learned property value of the value description properties is "#0" instead of "". 
  Workaround: Use the Object property to retrieve the correct property value.
• WebList objects created with the "role=list" property are not supported on Microsoft Edge.
• When a role-based WebList object loads items dynamically the WebList.MakeItemVisible method may have unexpected results.

Operations

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

Note: You can also view a list and descriptions of the WebList 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	Deselects the specified item in the 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 a 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.
MakeItemVisible	Makes an item in the list visible.
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 the specified item in the list, replacing any previously selected values.
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

Click Method

Description

Clicks the object.

Syntax

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

Arguments

Return Type

None

IMPORTANT

• Recording options for this method are defined in the Advanced tab of the Web Options dialog box. For details, see the section on the Web > Advanced pane in the UFT One Help Center.
• For some Mozilla FireFox objects, this method is recorded only if a handler is present. For details, see the topic on working with multiple browsers in the UFT One Help Center.
• If you are testing a web or hybrid application on a mobile device, this method is equivalent to performing the Tap gesture.

Example

Click the WebElement with HTML TAG=Form (VBScript)

'The following example uses the Click method on a form.

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

Back to top

Deselect Method

Description

Deselects the specified item in the list.

Syntax

object.Deselect Item

Arguments

Return Type

None

Example

Remove Selected Items from List (VBScript)

 'The following example uses the Deselect method to remove selected items from a WebList object
'after first adding them to the list.
Browser("Find a Flight").Page("Fill-Out Form Example").WebList("what-to-wear").Select "Rugby Shirt"
Browser("Find a Flight").Page("Fill-Out Form Example").WebList("what-to-wear").ExtendSelect "Leather Jacket"
Browser("Find a Flight").Page("Fill-Out Form Example").WebList("what-to-wear").ExtendSelect "Boots"
'Check if all items that were selected in the previous steps are actually selected in the list
CurrentSelection = Browser("Find a Flight").Page("Fill-Out Form Example").WebList("what-to-wear").GetROProperty("selection")
If CurrentSelection <> "Rugby Shirt;Leather Jacket;Boots" Then
    Reporter.ReportEvent micFail, "ExtendSelect", "The list does not contain all of the selected items."
Else
   Reporter.ReportEvent micPass, "ExtendSelect", "The list contains all selected items."
End If
'Remove two items from the list
Browser("Find a Flight").Page("Fill-Out Form Example").WebList("what-to-wear").Deselect "Boots"
Browser("Find a Flight").Page("Fill-Out Form Example").WebList("what-to-wear").Deselect "Rugby Shirt"
'Verify that the deselected items are no longer selected in the list
CurrentSelection = Browser("Find a Flight").Page("Fill-Out Form Example").WebList("what-to-wear").GetROProperty("selection")
If CurrentSelection <> "Leather Jacket" Then
    Reporter.ReportEvent micFail, "Deselect", "Deselect for this specific list does not work properly"
Else
   Reporter.ReportEvent micPass, "Deselect", "Deselect for this specific list succeeded"
End If

Remove a Selected Item from a List (VBScript)

'The following example uses the Deselect method to remove
'Headphones from a list of selected products.

Browser("Advantage Shopping").Page("Advantage Shopping").WebList("categoryListboxContactUs").Select "Headphones"
Browser("Advantage Shopping").Page("Advantage Shopping").WebList("categoryListboxContactUs").Select "Speakers"
Browser("Advantage Shopping").Page("Advantage Shopping").WebList("categoryListboxContactUs").Deselect "Headphones"

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 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.

• 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 the WebElement with HTML TAG=Form (VBScript)

                    'The following example uses the DoubleClick method on a form.

Browser("New Page").Page("New Page").WebElement("html tag:=Form").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

IMPORTANT

• Drag and Drop operations are performed as a coupled step. Inserting one operation without the other causes an error to occur in the run session.
• This test object method is not supported on Safari browsers.

UFT One supports the following scenarios:

• Scenario A: One object is dragged onto another object. For example, you can drag a WebButton from one frame object (source object) to another object (target object), or drag a WebElement (source object) onto a Link object (target object) in the same frame.
  
  
• Scenario B: An object is moved from one location in a frame to another location in the same frame. In this case, the test object used for the Drag step is the same as the test object used for the Drop step.
  
  
• Scenario C: An item within an object is moved to another location within that object (also known as drag and pan). For example, in a map application, you can relocate an image relative to itself or drag a Slider object.
  
  

General Note:

UFT One always runs Drag and Drop steps using the mouse API, even if you defined the Replay type as Event in the Run Settings section of the Web > Advanced pane (Tools > Options > GUI Testing tab >Web pane > Advanced node). 

Notes for Scenario A:

--Recording session. You cannot record cross-object or cross-frame types of drag and drop operations (operations in which you try to drop an object on another object or in another frame). You can, however, insert these types of Drop steps manually. Note that it may be helpful to record a drag and drop operation on the object in order to determine valid coordinates for the Drag operation step. You will need to delete the recorded Drop step, though, and manually add a new Drop step for the target object instead. 

--Run session. If the application being tested supports scrolling, then UFT One supports scrolling when the Drag and Drop test objects are both located in the same frame. UFT One drags the Drag object to edge of the frame, waits for the Drop object to appear, and drops the Drag object onto the Drop object. If the application being tested does not support scrolling, then UFT One displays an error message when it reaches a step that requires scrolling. 

--Run session. If you want to drag a test object from one frame to another, UFT One tries to make both the Drag and Drop objects visible in their frames prior to performing the Drag and Drop operation. If the two objects cannot be viewed simultaneously (for example, because the browser window is too small), the step will fail.

Notes for Scenario B and Scenario C:

--If the screen resolution during a run session is not the same as the screen resolution during the recording session, then the size of the frame may be different during the run session as compared to the recording session. In this case, the target location coordinates may be different during the run session, and this may cause the test steps to fail.

--During a run session, if the coordinates of a Drop step are located outside of the visible frame area (for example, because your application changed), then the step may not run accurately. To solve this, fix the specified coordinates, as needed. The test object can be dragged only within the visible area of the frame object. Dragging the object to the edge of a window or frame does not cause the area to scroll (as it does in Scenario A).

Example

Drag and Drop an Email Item (VBScript)

                    'The following example uses the Drag and Drop methods to drag a copy of an item from the Inbox pane of
'Microsoft Outlook Web Access and drop it in the Junk folder. Then it uses the Drag and Drop methods again
'to move the item from the Junk folder to the Deleted Items folder.

Browser("Microsoft Outlook Web").Page("Microsoft Outlook Web_2").Frame("viewer").WebElement("MyEmail").Drag , micNoCoordinate, micNoCoordinate, micCtrl
Browser("Microsoft Outlook Web").Page("Microsoft Outlook Web_2").Frame("navbar").Link("Junk E-mail").Drop
Browser("Microsoft Outlook Web").Page("Microsoft Outlook Web_2").Frame("viewer").WebElement("MyEmail").Drag
Browser("Microsoft Outlook Web").Page("Microsoft Outlook Web_2").Frame("navbar").Link("Deleted Items").Drop

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

IMPORTANT

• Drag and Drop operations are performed as a coupled step. Inserting one operation without the other causes an error to occur. For more information on Drag and Drop operations, see Drag Method.
• This test object method is not supported on Safari browsers.

Example

Drag and Drop an Email Item (VBScript)

                    'The following example uses the Drag and Drop methods to drag a copy of an item from the Inbox pane of
'Microsoft Outlook Web Access and drop it in the Junk folder. Then it uses the Drag and Drop methods again
'to move the item from the Junk folder to the Deleted Items folder.

Browser("Microsoft Outlook Web").Page("Microsoft Outlook Web_2").Frame("viewer").WebElement("MyEmail").Drag , micNoCoordinate, micNoCoordinate, micCtrl
Browser("Microsoft Outlook Web").Page("Microsoft Outlook Web_2").Frame("navbar").Link("Junk E-mail").Drop
Browser("Microsoft Outlook Web").Page("Microsoft Outlook Web_2").Frame("viewer").WebElement("MyEmail").Drag
Browser("Microsoft Outlook Web").Page("Microsoft Outlook Web_2").Frame("navbar").Link("Deleted Items").Drop

Back to top

ExtendSelect Method

Description

Adds selected items to a multi-selection list.

Syntax

object.ExtendSelect Item

Arguments

Return Type

None

Example

Select an Additional Item by Specifying the Item Name (VBScript)

                    'The following example uses the ExtendSelect method to select
'Socks from a list of clothing after Jeans has already been selected.

Browser("index").Page("Fill-Out Form_2").WebList("what-to-wear").Select "Jeans"
Browser("index").Page("Fill-Out Form_2").WebList("what-to-wear").ExtendSelect "Socks"

Select an Additional Item by Specifying the Item Index (VBScript)

                    'The following example uses the ExtendSelect method to select
'the third item from a list of clothing.

Browser("index").Page("Fill-Out Form_2").WebList("what-to-wear").ExtendSelect "#2"

Select Two Additional Items from a List and Verify their Selection (VBScript)

                    'The following example uses the ExtendSelect method to select
'two additional items from a WebList object and then checks
'if the items were actually selected. The results of the
'check are sent to the run results.
Browser("Find a Flight").Page("Fill-Out Form Example").WebList("what-to-wear").Select "Rugby Shirt"
Browser("Find a Flight").Page("Fill-Out Form Example").WebList("what-to-wear").ExtendSelect "Leather Jacket"
Browser("Find a Flight").Page("Fill-Out Form Example").WebList("what-to-wear").ExtendSelect "Boots"
'Check if all items that were selected in the previous steps are
'actually selected in the list and send
CurrentSelection = Browser("Find a Flight").Page("Fill-Out Form Example").WebList("what-to-wear").GetROProperty("selection")
If CurrentSelection <> "Rugby Shirt;Leather Jacket;Boots" Then
    Reporter.ReportEvent micFail, "ExtendSelect", "The list does not contain all of the selected items."
Else
   Reporter.ReportEvent micPass, "ExtendSelect", "The list contains all selected items."
End If

Back to top

FireEvent Method

Description

Triggers an event.

Syntax

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

Arguments

Return Type

None

Example

Fire the OnPropertyChange Event on a Form (VBScript)

                    'The following example uses the FireEvent method to trigger
'the onpropertychange event on a form.

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

Back to top

GetItem Method

Description

Returns the value of the item specified by the index.

Syntax

object.GetItem (Index)

Arguments

Return Type

A String value.

Example

Retrieve the Value of the First List Item (VBScript)

                    'The following example uses the GetItem method to display the
'value of the first item in the list.

MsgBox Browser("Fill-Out Form").Page("Fill-Out Form").WebList("what-to-do").GetItem(1)

Retrieve the Values from a List of Names in an Array (VBScript)

                    'The following example uses the GetItem method to retrieve the names
'of students from an array in order to send them their grades. First
'the example uses the GetTOProperty method to retrieve the number of
'items from the list of student names. Then it generates an array
'according to the list size, inserting the each of the student's names
'into the array. It then uses the GetItem method to retrieve each
'student's name. Finally it uses a function to send grades to the students.

ListSize = Browser("ListOfStudentNames").Page("ListOfStudentNames").WebList("ListOfStudentNames").GetTOProperty("items count")
Dim NamesArray()
'Dynamically allocate an array according to the list size
ReDim NamesArray(ListSize - 1)
For i = 1 To ListSize
     NamesArray(i - 1) = Browser("ListOfStudentNames").Page("ListOfStudentNames").WebList("ListOfStudentNames").GetItem(i)
Next
'The following function uses the array of student names in order to send grades to the students.
SendGradesByStudentName (NameArray)

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 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.

Example

Hover Over or Tap a Checkbox (VBScript)

'When performed in an environment that supports hovering, such as a desktop browser,
'the following example hovers over the checkbox, perhaps displaying a tooltip.

'When performed in an environment that does not support hovering, such as a mobile 
'browser, the example taps the checkbox instead, perhaps selecting it.

Browser("Advantage Shopping").Page("Advantage Shopping").WebCheckBox("operating_system_1").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

MakeItemVisible Method

Description

Makes an item in the list visible.

Syntax

object.MakeItemVisible Item, xPath, [Timeout]

Arguments

Example

Click to scroll an item into view (VBScript)

'Navigate to https://www.jqwidgets.com/jquery-widgets-demo/demos/jqxdropdownlist/index.htm'. 
'The following example performs the click to scroll the item into view.

'Expand the WebList
Browser("jQuery DropDownList").Page("jQuery DropDownList").WebElement("WebElement").Click
'Scroll to the item.
Browser("jQuery DropDownList").Page("jQuery DropDownList").WebList("innerListBoxdropDownList").MakeItemVisible "Anne DodsworthSales Representative", "//*[@id=""jqxScrollBtnDownverticalScrollBarinnerListBoxdropDownList""]/div"

Back to top

MiddleClick Method

Description

Middle-clicks the object.

Syntax

object.MiddleClick [x], [y]

Arguments

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 Even Recording Configuration dialog box in the UFT One Help Center.
• When Event Replay is selected for the Replay type option (by using Tools > Options > GUI Testing tab >Web pane > Advanced node), UFT One fires onmousedown, focus, 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.

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 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 in Internet Explorer and older versions of FireFox.

Example

Panning across a Google Maps web page (VBScript)

                    'The following example performs a Pan gesture on a Google Maps web page, panning diagonally to the bottom right.

Device("Device").App("MC Browser").MobileWebView("Web View").Page("Google Maps").WebElement("WebElement").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 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 in Internet Explorer and older versions of FireFox.

Example

Pinch to zoom in on a Google Maps page (VBScript)

                    'The following example performs a Pinch gesture on a Google Maps web page, where the zoom is multiplied by 2.5.

Device("Device").App("MC Browser").MobileWebView("Web View").Page("Google Maps").WebElement("WebElement").Pinch 2.5

Back to top

RightClick Method

Description

Right-clicks the object.

Syntax

object.RightClick [x], [y]

Arguments

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 Even Recording Configuration dialog box in the UFT One Help Center.
• When Event Replay is selected for the Replay type option (by using Tools > Options > GUI Testing tab >Web pane > Advanced node), UFT One fires onmousedown, focus, 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.

Back to top

Select Method

Description

Selects the specified item in the list, replacing any previously selected values.

Syntax

object.Select Item

Arguments

Return Type

None

IMPORTANT

• If you are using this test object method for a WebList object in which the description property "role=listbox", UFT One selects the item only if it is visible in the current listbox frame.
• If this object has a scroll bar on the left side of the list, UFT One cannot scroll to an invisible item and select the item.

Example

Select a List Item by Specifying the Item Name (VBScript)

                    'The following example uses the Select method to select a category
'by its name in the list of all available categories.

Browser("Advantage Shopping").Page("Advantage Shopping").WebList("categoryListboxContactUs").Select "Headphones"

Select a List Item by Specifying the Item Index (VBScript)

                    'In the following example, the Select method is used to
'select a city by its index number in the list of possible
'arrival cities.

Browser("Advantage Shopping").Page("Advantage Shopping").WebList("productListboxContactUs").Select "#1"

Select an Item from a List and Verify Its Selection (VBScript)

                    'The following example uses the Select method to select
'an item from a WebList object and then checks
'if the item and others were actually selected.
'The results of the check are sent to the run results.
Browser("Find a Flight").Page("Fill-Out Form Example").WebList("what-to-wear").Select "Rugby Shirt"
Browser("Find a Flight").Page("Fill-Out Form Example").WebList("what-to-wear").ExtendSelect "Leather Jacket"
Browser("Find a Flight").Page("Fill-Out Form Example").WebList("what-to-wear").ExtendSelect "Boots"
'Check if all items that were selected in the previous steps are
'actually selected in the list and send
CurrentSelection = Browser("Find a Flight").Page("Fill-Out Form Example").WebList("what-to-wear").GetROProperty("selection")
If CurrentSelection <> "Rugby Shirt;Leather Jacket;Boots" Then
    Reporter.ReportEvent micFail, "ExtendSelect", "The list does not contain all of the selected items."
Else
   Reporter.ReportEvent micPass, "ExtendSelect", "The list contains all selected items."
End If

Back to top

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.

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

Example

Swipe a WebList Object (VBScript)

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

Device("Device").App("Mobile Web_2").MobileWebView("Web View").Page("Checkbox and radio inputs").WebList("what-to-wear").Swipe moveDown,200,1,75,75

Back to top

See also:

• Browser
• Frame
• Image
• Link
• Page
• ViewLink
• WebAgGrid
• WebArea
• WebAudio
• WebButton
• WebCheckBox
• WebEdit
• WebElement
• WebFile
• WebList
• WebMenu
• WebNumber
• WebRadioGroup
• WebRange
• WebTable
• WebTabStrip
• WebTree
• WebUIGrid
• WebVideo
• WebXML