Share this page
SblOUIDropDownButton Object
Description
A Siebel Open UI button that opens a dropdown menu..
IMPORTANT
The SblOUIComboBox test object class extends the WebButton test 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 SblOUIDropDownButton object.
Note: You can also view a list and descriptions of the SblOUIDropDownButton 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. |
| 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. |
| Close | Closes a dropdown menu. |
| 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. |
| FireEvent | Triggers an event. |
| GetROProperty | Returns the current value of the specified 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. |
| internalClose | internalClose |
| internalOpen | internalOpen |
| internalSelect | internalSelect |
| IsItemEnabled | Checks if a selected item in the dropdown button is enabled. |
| LongPress | Presses and holds the object. |
| MiddleClick | Middle-clicks the object. |
| Open | Opens a dropdown menu. |
| 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 an item (by name) in the dropdown menu. |
| SetTOProperty | Sets the value of the specified description property in the test object description. |
| SiebelAppSync | Wait while the siebel application is busy. |
| 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. |
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 object. 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 (-9999) for the X and Y argument values if you want to enter a value of the button argument without specifying x- and y- coordinates for the click. micNoCoordinate indicates the center of the object. Default value = 0 |
| BUTTON |
Optional. A predefined constant or number. The mouse button used to click the object. UFT One does not record the Click method for right- or middle-clicks. Instead, UFT One records the RightClick and MiddleClick methods. Default value = micLeftBtn |
Return Type
None
IMPORTANT
- Recording options for this method are defined in the Web > 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.
Example
Click a DropDown Button Object (VBScript)
'The following example clicks a SblOUIDropDown object.
Browser("My Opportunities: abcgde").Page("My Opportunities: abcgde").SblOUIApplet("Opportunities List Applet").SblOUIDropDownButton("SblOUIDropDownButton").Click
Close Method
Description
Closes a dropdown menu.
Syntax
object.Close
Return Type
None
Example
Close the Dropdown List (VBScript)
'The following example closes the list that opens when you click a SblOUIDropDown button.
Browser("My Opportunities: abcgde").Page("My Opportunities: abcgde").SblOUIApplet("Opportunities List Applet").SblOUIDropDownButton("SblOUIDropDownButton").Close
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 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 an Open AdvancedEdit object (Visual Basic)
'The following example double-clicks a SblOUIAdvancedEdit object.
Browser("Product Administration:").Page("Siebel Web Call Center_2").SblOUIAdvancedEdit("Account").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. 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
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 > Advanced node).
Notes for Scenario A:
- While recording: 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 need to delete the recorded Drop step, though, and manually add a new Drop[ step for the target object instead.
- While running: 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 the 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.
- While running: If you want to drag a test object from one frame to another, UFT One tries to make 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 fails.
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 a DropDown Button Object (VBScript)
'The following example drags a SblOUIDropDown object to the specified coordinates.
Browser("My Opportunities: abcgde").Page("My Opportunities: abcgde").SblOUIApplet("Opportunities List Applet").SblOUIDropDownButton("SblOUIDropDownButton").Drag 75,75
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 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 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 couple 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
Drag a DropDown Button Object (VBScript)
'The following example drops a dragged SblOUIDropDown button object on the specified coordinates.
Browser("My Opportunities: abcgde").Page("My Opportunities: abcgde").SblOUIApplet("Opportunities List Applet").SblOUIDropDownButton("SblOUIDropDownButton").Drag 90, 100
FireEvent Method
Description
Triggers an event.
Syntax
object.FireEvent EventName, [x], [y], [BUTTON]
Arguments
| Parameter | Description |
|---|---|
| EventName |
Required. A String value. The name of an event to trigger: Available events:
|
| 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 event. Default value = micLeftBtn |
Return Type
None
Example
Fire the OnClick Event on a DropDown Button (VBScript)
'The following examples uses the FireEvent method to simulate clicking
'on a SblOUIDropDown button.
Browser("My Opportunities: abcgde").Page("My Opportunities: abcgde").SblOUIApplet("Opportunities List Applet").SblOUIDropDownButton("SblOUIDropDownButton").FireEvent "onclick"
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 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.
internalClose Method
Description
internalClose
Syntax
object.internalClose
Return Type
None
internalOpen Method
Description
internalOpen
Syntax
object.internalOpen
Return Type
None
internalSelect Method
Description
internalSelect
Syntax
object.internalSelect Path
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value. |
Return Type
None
IsItemEnabled Method
Description
Checks if a selected item in the dropdown button is enabled.
Syntax
object.IsItemEnabled Path
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value. The path to the item in the dropdown list (by name). |
Return Type
None
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 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
Perform a LongPress on a Dropdown Button (VBScript)
'The following example performs a LongPress on a SblOUIDropDownButton object.
Device("Device").App("Mobile Web_2").MobileWebView("Web View").Page("Checkbox and radio inputs").SblOUIDropDownButton("SblOUIDropDownButton").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-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 |
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 preconfigured level. For details, see the topic on the Custom Web Event Recording Configuration in the Add-ins section of the UFT One Help Center.
- When Event replay is selected for the Replay type option (in the Tools > Options > GUI Testing tab > Web > Advanced pane), UFT One fires onmousedown, focus, and onmouseup events for this method, which may cause slightly different behavior for the regular Click Method value for the Button argument.
Open Method
Description
Opens a dropdown menu.
Syntax
object.Open
Return Type
None
Example
Open the Dropdown List for a Button (VBScript)
'The following example opens the dropdown list that is displayed when clicking a
'SblOUIDropDownButton.
Browser("My Opportunities: abcgde").Page("My Opportunities: abcgde").SblOUIApplet("Opportunities List Applet").SblOUIDropDownButton("SblOUIDropDownButton").Open
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 perform 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 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
Pan across an Open AdvancedEdit object (Visual Basic)
'The following example pans across a SblOUIAdvancedEdit object.
Browser("Product Administration:").Page("Siebel Web Call Center_2").SblOUIAdvancedEdit("Account").Pan 564, 507
Pinch Method
Description
Perform a pinch gesture.
Syntax
object.Pinch scale, [duration], [x], [y]
Arguments
| Parameter | Description |
|---|---|
| scale |
Required. A Variant. |
| duration |
Optional. A Variant. |
| x |
Optional. An integer value. Default value = 0 |
| y |
Optional. An integer value. 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 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
Pinch to zoom in on an Open AdvancedEdit object (VBScript)
'The following example pinches to zoom in on a SblOUIAdvancedEdit object.
Browser("Product Administration:").Page("Siebel Web Call Center_2").SblOUIAdvancedEdit("Account").Pinch 2.5
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 object. 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 topic on the Custom Web Event Recording Configuration in the Add-ins section of the UFT One Help Center.
- When Event replay is selected for the Replay type (in the Tools > Options > GUI Testing tab > Web > Advanced pane), 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.
Select Method
Description
Selects an item (by name) in the dropdown menu.
Syntax
object.Select Path
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value. The path to the item in the dropdown list (by name). |
Return Type
None
Example
Select an Item from the Dropdown List (VBScript)
'The following example selects an item from the list that opens when you
'click a SblOUIDropDown button.
Browser("My Opportunities: abcgde").Page("My Opportunities: abcgde").SblOUIApplet("Opportunities List Applet").SblOUIDropDownButton("SblOUIDropDownButton").Select "New Query [Alt+Q]"Browser("My Opportunities: abcgde").Page("My Opportunities: abcgde").SblOUIApplet("Opportunities List Applet").SblOUIDropDownButton("SblOUIDropDownButton").Select "New Query [Alt+Q]"
SiebelAppSync Method
Description
Wait while the siebel application is busy.
Syntax
object.SiebelAppSync
Return Type
None
Example
Wait While the Siebel Application Syncs (VBScript)Browser("Product Administration:").Page("Siebel Web Call Center_2").SblOUIAdvancedEdit("Account").SiebelAppSync
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 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 Dropdown Button (VBScript)
'The following example performs a Swipe gesture on a SblOUIDropDownButton object.
Device("Device").App("Mobile Web_2").MobileWebView("Web View").Page("Checkbox and radio inputs").SblOUIDropDownButton("SblOUIDropDownButton").Swipe moveDown,200,1,75,75
See also:
