Share this page
SblOUIAdvancedEdit Object
Description
A Siebel Open UI Advanced Edit field.
IMPORTANT
The SblOUIAdvancedEdit test object class extends the WebEdit test object class and inherits many of its operations and description properties.
When recording on an AdvancedEdit object, UFT One records operations performed on AdvancedEdit operations that open an additional applet to enter information. For calendar-, combobox-, and calculator-type AdvancedEdit objects, UFT One records only the information or value entered.
Operations
The sections below list the built-in methods and properties that you can use as operations for the SblOUIAdvancedEdit object.
Note: You can also view a list and descriptions of the SblOUIAdvancedEdit 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 the AdvancedEdit object. |
| 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 | internal Close |
| internalOpen | internal Open |
| LongPress | Presses and holds the object. |
| MiddleClick | Middle-clicks the object. |
| Open | Opens the Edit object by clicking on its button. |
| 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. |
| Set | Sets the edit value. |
| SetSecure | Sets the encrypted value of an edit box. |
| 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, relative to the upper left corner of the object. Default value = 0 |
| y |
Optional. An integer value. The x-coordinate of the click, relative to the upper left corner of the object. 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 Advanced tab of the Web Options dialog box (Tools > Options > GUI Testing tab > Web > Advanced pane). 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 the SblOUIObject with NAME=REQUEST SERVICE (VBScript)
'The following example clicks the SblOUIObject with the name=Request Service.
Browser("Browser").Page("Siebel Web Call Center").SblOUIObject("name = Request Service").Click
Close Method
Description
Closes the AdvancedEdit object.
Syntax
object.Close
Return Type
None
IMPORTANT
- This method is used only for currency-type AdvancedEdit objects. You must press ESC to record the Close method.
- UFT One does not record the Close method when you enter a value using the AdvancedEdit object's button. If you need to include a Close method statement for an object in your test, enter it manually in the Editor.
Example
Close an Open AdvancedEdit Object (VBScript)
'The following example closes a SblOUIAdvancedEdit object.
Browser("Product Administration:").Page("Siebel Web Call Center_2").SblOUIAdvancedEdit("Account").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 mouse 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.
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:
- When 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.
- When 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.
- When running: 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 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 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 the SblOUIObject with the NAME=REQUEST SERVICE (VBScript)
'The following example drags the SblOUIObject with the name "Request Service".
Browser("Browser").Page("Siebel Web Call Center").SblOUIObject("name = Request Service").Drag micNoCoordinate, micNoCoordinate, micLeftBtn, micCtrl
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 without the other causes an error to occur. For more details on Drag and Drop operations, see Drag Method.Example
Drop the Object with the NAME=REQUEST SERVICE (VBScript)'The following example drops the SblOUIObject with the name "Request Service Browser("Browser").Page("Siebel Web Call Center").SblOUIObject("name = Request Service").Drop
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 (DHTML) Object model are supported. Refer to the DHTML Events section of the MSDN Library documentation for further information. |
| 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 OnPropertyChange Event on a SblOUIObject (VBScript)'The following example uses the FireEvent method to trigger 'the onpropertychange event on a SblOUIObject. Browser("Browser").Page("Siebel Web Call Center").SblOUIObject("name = Request Service").FireEvent "onpropertychange"
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
internal Close
Syntax
object.internalClose
Return Type
None
internalOpen Method
Description
internal Open
Syntax
object.internalOpen
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 Advanced Edit Object (VBScript)'The following example performs a LongPress on an SblOUIAdvancedEdit object. Device("Device").App("Mobile Web_2").MobileWebView("Web View").Page("Checkbox and radio inputs").SblOUIAdvancedEdit("Account").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 ot the upper left corner of the object. The default value is the center of the object. Default value = 0 |
Return Type
None
Example
MiddleClick the SblOUIObject with NAME=REQUEST SERVICE (VBScript)'The following example clicks the SblOUIObject with the name "Request Service" 'with the middle mouse button. Browser("Browser").Page("Siebel Web Call Center").SblOUIObject("name = Request Service").MiddleClick
Open Method
Description
Opens the Edit object by clicking on its button.
Syntax
object.Open
Return Type
None
IMPORTANT
UFT One records an Open method only for AdvancedEdit objects that open applet-type windows or for read-only calendar-, combobox-, or calculator-type AdvancedEdit objects.
For other types of AdvancedEdit objects, UFT One records a Set method with the value entered.
Example
Open an AdvancedEdit Object (VBScript)'The following example opens an SblOUIAdvancedEdit object. Browser("Product Administration:").Page("Siebel Web Call Center_2").SblOUIAdvancedEdit("Account").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. 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 Default value = 0 |
| y |
Optional. An integer value. 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 Default value = 0 |
Return Type
None
Example
Right Click the SblOUIObject with the NAME=REQUEST SERVICE (VBScript)'The following example right clicks the SblOUIObject with the name "Request Service" 'with the right mouse button. Browser("Browser").Page("Siebel Web Call Center").SblOUIObject("name = Request Service").RightClick
Set Method
Description
Sets the edit value.
Syntax
object.Set Text
Arguments
| Parameter | Description |
|---|---|
| Text |
Required. A String value. The new value of the object. |
Return Type
None
IMPORTANT
Notes:
- For all types of AdvancedEdit objects, UFT One records this method when you type information into the object's fields.
- For the Advanced Edit calendar, combobox, and calculator objects, UFT One records this method when you select a value from the object popup fields and click outside the edit field or press TAB.
- If you enter information into a read-only field when recording, the entered information is not saved.
- If you are using an AdvancedEdit object inside a table, you UFT One records the Set method only when you click on another cell (not when you press TAB to move between cells).
Example
Set the Value of the AdvancedEdit Object (VBScript)'The following example sets the value of the "Account" AdvancedEdit object. Browser("Product Administration:").Page("Siebel Web Call Center_2").SblOUIAdvancedEdit("Account").Set "My Company, Inc."
SetSecure Method
Description
Sets the encrypted value of an edit box.
Syntax
object.SetSecure EncryptedText
Arguments
| Parameter | Description |
|---|---|
| EncryptedText |
Required. A String value. New value of the object in encrypted form. |
Return Type
None
IMPORTANT
This method is used for edit boxes in which a password is entered.
Note: While the SetSecure method enables you to hide passwords on the screen when running a test, it is not intended to be a secure way to protect password information.
Tip: To manually encrypt a password, use the Password Encode tool installed with the main installation of UFT One (available from the Windows Start menu).
Example
Enter an Encrypted String in an Advanced Edit Box (VBScript)'The following example uses the SetSecure method to enter an encrypted string 'in an AdvancedEdit box. Browser("Product Administration:").Page("Siebel Web Call Center_2").SblOUIAdvancedEdit("Account").SetSecure "53749f9042b4960fb94d3b349577c"
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 Advanced Edit Object (VBScript)'The following example performs a Swipe gesture on a SblOUIAdvancedEdit object. Device("Device").App("Mobile Web_2").MobileWebView("Web View").Page("Checkbox and radio inputs").SblOUIAdvancedEdit("Account").Swipe moveDown,200,1,75,75
See also:
