Share this page
SblOUITable Object
Description
A Siebel Open UI Table.
IMPORTANT
The SblOUITable test object class extends the WebElement test object class and inherits many of its operations and description properties.
Notes:
- UFT One does not record operations performed on the table's Next or Previous buttons.
- UFT One records embedded Table objects as child objects of the Page object. If your Table object is a child object of another object, you may need to manually insert additional levels of the object's hierarchy in your test.
Operations
The sections below list the built-in methods and properties that you can use as operations for the SblOUITable object.
Note: You can also view a list and descriptions of the SblOUITable 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
 ActivateRow | Activates the specified table row. |
 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. |
| 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. |
| ExtendSelectCell | Clicks on the cell with the specified coordinates. |
| FireEvent | Triggers an event. |
| GetCellData | Returns the text for a specified cell. |
| 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. |
| internalActivateVisibleRow | ActivateRow |
| internalGetCellData | internalSort |
| internalMakeRowVisible | internalMakeRowVisible |
| internalSelectCell | internalSort |
| internalSort | internalSort |
| 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. |
| SelectCell | Clicks on the cell with the specified coordinates. |
| SetTOProperty | Sets the value of the specified description property in the test object description. |
| SiebelAppSync | Wait while the siebel application is busy. |
| SortDown | Sorts the table in descending order based on the contents of the specified column. |
| SortUp | Sorts the table in ascending order based on the contents of the specified column. |
| 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. |
ActivateRow Method
Description
Activates the specified table row.
Syntax
object.ActivateRow Row
Arguments
| Parameter | Description |
|---|---|
| Row |
Required. An integer value. The currently selected row. |
Return Type
None
Example
Activate a Row in a Table (VBScript)
'The following example activates the selected row in a SblOUITable.
Browser("Browser").Page("Siebel Web Call Center").SblOUITable("Products").ActivateRow 11
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 y-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
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
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.
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
ExtendSelectCell Method
Description
Clicks on the cell with the specified coordinates.
Syntax
object.ExtendSelectCell Column, Row, Key
Arguments
| Parameter | Description |
|---|---|
| Column |
Required. A String value. The column number or index number of the column where the cell is located. (The first column in the table is numbered 1.) To specify the index of the item to select, use "#index." |
| Row |
Required. An integer value. The row number where the cell is located. (The first row in the table is numbered 1.) |
| Key |
Required. A String value. The text of the cell to select. |
Return Type
None
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. 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"
GetCellData Method
Description
Returns the text for a specified cell.
Syntax
object.GetCellData (Col, Row)
Arguments
| Parameter | Description |
|---|---|
| Col |
Required. A String value. The column number or column header label where the cell is located. (The first column in the table is numbered 1.) |
| Row |
Required. An integer value. The row number where the cell is located. (The first row in the table is numbered 1.) |
Return Type
A String value.
Example
Retrieve the Data from the Selected Cell (VBScript)'The following example retrieves the data from the selected cell in an SblOUITable. Browser("Browser").Page("Siebel Web Call Center").SblOUITable("Products").GetCellData ("Name",2)
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.
internalActivateVisibleRow Method
Description
ActivateRow
Syntax
object.internalActivateVisibleRow Row
Arguments
| Parameter | Description |
|---|---|
| Row |
Required. An integer value. |
Return Type
None
internalGetCellData Method
Description
internalSort
Syntax
object.internalGetCellData Col, Row
Arguments
| Parameter | Description |
|---|---|
| Col |
Required. A String value. |
| Row |
Required. An integer value. |
Return Type
None
internalMakeRowVisible Method
Description
internalMakeRowVisible
Syntax
object.internalMakeRowVisible (Row)
Arguments
| Parameter | Description |
|---|---|
| Row |
Required. An integer value. |
Return Type
An integer value.
internalSelectCell Method
Description
internalSort
Syntax
object.internalSelectCell Col, Row, Key
Arguments
| Parameter | Description |
|---|---|
| Col |
Required. A String value. |
| Row |
Required. An integer value. |
| Key |
Required. A String value. |
Return Type
None
internalSort Method
Description
internalSort
Syntax
object.internalSort Col, Dir
Arguments
| Parameter | Description |
|---|---|
| Col |
Required. A String value. |
| Dir |
Required. A Boolean value. |
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 Table Object (VBScript)'The following example performs a LongPress on a SblOUITable object. Device("Device").App("Mobile Web_2").MobileWebView("Web View").Page("Checkbox and radio inputs").SblOUITable("Products").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. 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
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
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
SelectCell Method
Description
Clicks on the cell with the specified coordinates.
Syntax
object.SelectCell Column, Row
Arguments
| Parameter | Description |
|---|---|
| Column |
Required. A String value. The column name or index number of the column header label. (The first column in the table is numbered 1.) To specify the index of the item to select, use "#index." |
| Row |
Required. An integer value. The row number. (The first row in the table is numbered 1.) |
Return Type
None
Example
Select a Cell from a Table (VBScript)'The following example selects the specified cell from the SblOUITable. Browser("Browser").Page("Siebel Web Call Center").SblOUITable("Products").SelectCell "Part #", 25
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
SortDown Method
Description
Sorts the table in descending order based on the contents of the specified column.
Syntax
object.SortDown Col
Arguments
| Parameter | Description |
|---|---|
| Col |
Required. A String value. A column name or index number or the header label. (The first column in the table is numbered 1.) To specify the index of the item to select, use "#index." |
Return Type
None
Example
Sort the Table Rows in Descending Order (VBScript)'The following example sorts the rows in a SblOUITable in descending order. Browser("Browser").Page("Siebel Web Call Center").SblOUITable("Products").SortDown "#2"
SortUp Method
Description
Sorts the table in ascending order based on the contents of the specified column.
Syntax
object.SortUp Col
Arguments
| Parameter | Description |
|---|---|
| Col |
Required. A String value. The column name or index number or the header label. (The first column in the table is numbered 1.) To specify the index of the item to select, use "#index." |
Return Type
None
Example
Sort the Table Rows in Ascending Order (VBScript)'The following example sorts the SblOUITable rows in ascending order. Browser("Browser").Page("Siebel Web Call Center").SblOUITable("Products").SortUp "#2"
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 Table Object (VBScript)'The following example performs a Swipe gesture on a SblOUITable object. Device("Device").App("Mobile Web_2").MobileWebView("Web View").Page("Checkbox and radio inputs").SblOUITable("Products").Swipe moveDown,200,1,75,75
See also:
