Share this page
SblTreeView Object
Description
A tree view of specific screen data.
Operations
The sections below list the built-in methods and properties that you can use as operations for the SblTreeView object.
Note: You can also view a list and descriptions of the SblTreeView 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. |
| Collapse | Collapses the last node of the specified path. |
| Drag | Performs the 'drag' part of a drag and drop operation. |
| Drop | Performs the 'drop' part of a drag and drop operation. |
| Expand | Expands all the collapsed nodes along the specified path, including the last one. |
| FireEvent | Triggers an event. |
| GetDirectChildren | Returns a string listing child node text for each of the direct children of the specified node. |
| GetDirectChildrenCount | Returns the number of direct children for the specified node. |
| 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. |
| MiddleClick | Middle-clicks the object. |
| NextPage | Navigates to the next page in the tree. |
| NodeExists | Indicates whether the specified column exists in the tree. |
| Output | Retrieves the current value of an item and stores it in a specified location. |
| PrevPage | Navigates to the previous page in the tree. |
| 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 | Expands the SiebelTreeView object and clicks the last item in the path. |
| SetTOProperty | Sets the value of the specified description property in the test object description. |
| Submit | Submits a form. |
| 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. |
Click Method
Description
Clicks the object.
Syntax
object.Click [x], [y], [BUTTON]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. A long integer value. The x-coordinate of the click, relative to the upper-left corner of the object. Default value = -9999 |
| y |
Optional. A long integer value. The y-coordinate of the click, relative to the upper-left corner of the object. Default value = -9999 |
| BUTTON |
Optional. A predefined constant or number. The mouse button used to click the object. Default value = micLeftBtn |
Return Type
None
Example
Click on a Button (VBScript)
'The following example uses the Click method on the Campaign button
'object.
Browser("Siebel eChannel").Page("Siebel eChannel_8").Frame("Campaign Explorer").SblButton("Campaign").Click
Collapse Method
Description
Collapses the last node of the specified path.
Syntax
object.Collapse (Path)
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value. The path of the tree view object. The path is composed of the node names, separated by a semicolon. |
Return Type
None.
IMPORTANT
You can use the Collapse method to collapse the last node of the specified path.
Note: This method cannot be recorded, but can be inserted in the Editor or using the Method Wizard. For more information on using the Method Wizard, refer to the UFT One User Guide.
Example
Collapse a Specified Node in a Tree (VBScript)
'The following example uses the Collapse method to collapse the Platinum
'node of the Campaign tree view object.
Browser("Siebel eChannel").Page("Siebel eChannel_6").Frame("Campaign Explorer").SblTreeView("Campaign").Collapse "Campaign;Platinum "
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. A long integer value. The x-coordinate within the source object. Default = micNoCoordinate (center of the source object) Default value = -9999 |
| y |
Optional. A long integer value. The y-coordinate within the source object. Default = micNoCoordinate (center of the source object) Default value = -9999 |
| BUTTON |
Optional. A predefined constant or number. The mouse button used to drag the object. (Releasing the button performs the Drop operation.) Default = micLeftBtn (0) Default value = micLeftBtn |
| Modifier |
Optional. A String value. The keyboard modifier that is pressed during the Drag operation. Possible values: Default value = 0 |
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:
--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
Perform a Native Method on a Tab Strip Object (VBScript)
'The following example drags a Siebel button to a new location in the "View Frame".
Browser("Siebel Call Center").Page("Siebel Call Center").Frame("View Frame").SblButton("Add & Go").Drag 609, 238
Browser("Siebel Call Center").Page("Siebel Call Center").Frame("View Frame").SblButton("Add & Go").Drop 610, 240
Drop Method
Description
Performs the 'drop' part of a drag and drop operation.
Syntax
object.Drop [x], [y]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. A long 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 = micNoCoordinate (center of the target object) Default value = -9999 |
| y |
Optional. A long 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 = micNoCoordinate (center of the target object) Default value = -9999 |
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.Example
Perform a Native Method on a Tab Strip Object (VBScript)'The following example drags a Siebel button to a new location in the "View Frame". Browser("Siebel Call Center").Page("Siebel Call Center").Frame("View Frame").SblButton("Add & Go").Drag 609, 238 Browser("Siebel Call Center").Page("Siebel Call Center").Frame("View Frame").SblButton("Add & Go").Drop 610, 240
Expand Method
Description
Expands all the collapsed nodes along the specified path, including the last one.
Syntax
object.Expand (Path)
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value.
The path of the tree view object. The path is composed of the node names, separated by a semicolon.
|
Return Type
None.
IMPORTANT
Note: This method cannot be recorded, but can be inserted in the Editor or using the Method Wizard. For more information on using the Method Wizard, refer to the UFT One User Guide.Example
Expand a Specific Node in a Tree (VBScript)'The following example uses the Expand method to expand the Platinum 'node of the Campaign tree view object. Browser("Siebel eChannel").Page("Siebel eChannel_6").Frame("Campaign Explorer").SblTreeView("Campaign").Expand "Campaign;Platinum"
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. A long integer value. The x-coordinate, relative to the upper-left corner of the object. Default value = -9999 |
| y |
Optional. A long integer value. The y-coordinate, relative to the upper-left corner of the object. Default value = -9999 |
| BUTTON |
Optional. A predefined constant or number. The mouse button used to fire the event. Default value = micLeftBtn |
Return Type
None
IMPORTANT
This method is common to all Siebel test objects. For additional information and examples of usage, see SblButton.FireEvent.
Example
Fire an Event on an Advanced Edit Box (VBScript)'The following example uses the FireEvent method to fire the onfocus 'event on the Name SblAdvancedEdit. Browser("Siebel eChannel").Page("Siebel eChannel_3").Frame("My Opportunities").SblAdvancedEdit("Name:").FireEvent "onfocus"
GetDirectChildren Method
Description
Returns a string listing child node text for each of the direct children of the specified node.
Syntax
object.GetDirectChildren (Path)
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value.
The path of the tree view node. The path is composed of the node names, separated by a semicolon. If the path name is not unique, you can specify the index of the node, using "#index".
Index values begin with zero.
|
Return Type
A String value.
Example
Display a List of All Children of a Specific Node if it Exists (VBScript)'The following example checks whether the Assets node exists in the tree. If it does, it displays a message listing the names of each of the children of this node. Dim childrenCount ' check if the Assets node exists and get it's direct children If Browser("Siebel Partner Portal").Page("Siebel Partner Portal").Frame("Asset Explorer").SblTreeView("Assets").NodeExists("Assets") Then childrenCount = Browser("Siebel Partner Portal").Page("Siebel Partner Portal").Frame("Asset Explorer").SblTreeView("Assets").GetDirectChildrenCount("Assets") If (childrenCount > 0) Then MsgBox Browser("Siebel Partner Portal").Page("Siebel Partner Portal").Frame("Asset Explorer").SblTreeView("Assets").GetDirectChildren("Assets") End If End If
GetDirectChildrenCount Method
Description
Returns the number of direct children for the specified node.
Syntax
object.GetDirectChildrenCount (Path)
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value.
The path of the tree view node. The path is composed of the node names, separated by a semicolon. If the path name is not unique, you can specify the index of the node, using "#index".
Index values begin with zero.
|
Return Type
A long integer value.
Example
Display a List of All Children of a Specific Node if it Exists (VBScript)'The following example checks whether the Assets node exists in the tree. If it does, it displays a message listing the names of each of the children of this node. Dim childrenCount ' check if the Assets node exists and get it's direct children If Browser("Siebel Partner Portal").Page("Siebel Partner Portal").Frame("Asset Explorer").SblTreeView("Assets").NodeExists("Assets") Then childrenCount = Browser("Siebel Partner Portal").Page("Siebel Partner Portal").Frame("Asset Explorer").SblTreeView("Assets").GetDirectChildrenCount("Assets") If (childrenCount > 0) Then MsgBox Browser("Siebel Partner Portal").Page("Siebel Partner Portal").Frame("Asset Explorer").SblTreeView("Assets").GetDirectChildren("Assets") End If End If
MiddleClick Method
Description
Middle-clicks the object.
Syntax
object.MiddleClick [x], [y]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. A long integer value. The x-coordinate of the middle-click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = -9999 |
| y |
Optional. A long integer value. The y-coordinate of the middle-click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = -9999 |
Return Type
None
NextPage Method
Description
Navigates to the next page in the tree.
Syntax
object.NextPage
Return Type
None.
NodeExists Method
Description
Indicates whether the specified column exists in the tree.
Syntax
object.NodeExists (Path)
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value.
The path of the tree view node. The path is composed of the node names, separated by a semicolon. If the path name is not unique, you can specify the index of the node, using "#index".
Index values begin with zero.
|
Return Type
A Boolean value.
Example
Display a List of All Children of a Specific Node if it Exists (VBScript)'The following example checks whether the Assets node exists in the tree. If it does, it displays a message listing the names of each of the children of this node. Dim childrenCount ' check if the Assets node exists and get it's direct children If Browser("Siebel Partner Portal").Page("Siebel Partner Portal").Frame("Asset Explorer").SblTreeView("Assets").NodeExists("Assets") Then childrenCount = Browser("Siebel Partner Portal").Page("Siebel Partner Portal").Frame("Asset Explorer").SblTreeView("Assets").GetDirectChildrenCount("Assets") If (childrenCount > 0) Then MsgBox Browser("Siebel Partner Portal").Page("Siebel Partner Portal").Frame("Asset Explorer").SblTreeView("Assets").GetDirectChildren("Assets") End If End If
PrevPage Method
Description
Navigates to the previous page in the tree.
Syntax
object.PrevPage
Return Type
None.
RightClick Method
Description
Right-clicks the object.
Syntax
object.RightClick [x], [y]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. A long integer value. The x-coordinate of the right-click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = -9999 |
| y |
Optional. A long integer value. The y-coordinate of the right-click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = -9999 |
Return Type
None
Select Method
Description
Expands the SiebelTreeView object and clicks the last item in the path.
Syntax
object.Select (Item)
Arguments
| Parameter | Description |
|---|---|
| Item |
Required. A String value.
The path of the tree view node. The path is composed of the node names, separated by a semicolon. If the path name is not unique, you can specify the index of the node, using "#index".
Index values begin with zero.
|
Return Type
None.
IMPORTANT
This method is recorded when you click a link in the tree.
Note: UFT One ignores all Expand and Collapse operations during the recording session.
Example
Select a Specified Node in a Tree by Name (VBScript)'The following example uses the Select method to select the Platinum 'node from the SblTreeView. Browser("Siebel eChannel").Page("Siebel eChannel_6").Frame("Campaign Explorer").SblTreeView("Campaign").Select "Campaign;Platinum"
Select a Specified Node in a Tree by Index (VBScript)'The following example uses the Select method to select the second 'node in the SblTreeView, according to its index. Browser("Siebel eChannel").Page("Siebel eChannel_6").Frame("Campaign Explorer").SblTreeView("Campaign").Select "#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.
Example
Submit a Form Using a Siebel Pick List (VBScript)'The following example uses the Submit method to submit a form via the 'Name SblPickList box. Browser("Siebel eChannel").Page("Siebel eChannel_3").Frame("My Opportunities").SblPickList("Name:").Submit
See also:
- SblAdvancedEdit
- SblButton
- SblCheckBox
- SblEdit
- SblPickList
- SblTable
- SblTabStrip
- SblTreeView
- SiebApplet
- SiebApplication
- SiebButton
- SiebCalculator
- SiebCalendar
- SiebCheckbox
- SiebCommunicationsToolbar
- SiebCurrency
- SiebInkData
- SiebList
- SiebMenu
- SiebPageTabs
- SiebPDQ
- SiebPicklist
- SiebRichText
- SiebScreen
- SiebScreenViews
- SiebTask
- SiebTaskAssistant
- SiebTaskLink
- SiebTaskStep
- SiebTaskUIPane
- SiebText
- SiebTextArea
- SiebThreadbar
- SiebToolbar
- SiebTree
- SiebView
- SiebViewApplets
