Share this page
SAPTreeView Object
Description
An SAP Gui for HTML application tree object.
IMPORTANT
UFT One can record selection and activation operations on any item in an SAPTreeView object. Although UFT One does not record expand and collapse operations, it can select and activate items in an SAPTreeView object during the test run, regardless of whether it is expanded or collapsed.
UFT One records the column (item header) only when necessary.
Operations
The sections below list the built-in methods and properties that you can use as operations for the SAPTreeView object.
Note: You can also view a list and descriptions of the SAPTreeView 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
 Activate | Expands the SAPTreeView object and double-clicks the last item in the path. |
 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. |
| ChildItem | Returns a test object from a tree node by type and index. |
| 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 specified path of the SAPTreeView object during the test run. |
| 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. |
| Expand | Expands the SAPTreeView object to the specified path during the test run. |
| FireEvent | Triggers an event. |
| GetROProperty | Returns the current value of the description property from the object in the application. |
| GetTOProperties | Returns the collection of properties and values used to identify the object. |
| GetTOProperty | Returns the value of the specified description property from the test object description. |
| Highlight | Highlights the object in the application. |
| HoverTap | When hover is supported, places the pointer on the object. Otherwise, taps the object. |
| LongPress | Presses and holds the object. |
| MiddleClick | Middle-clicks the object. |
| OpenContextMenu | Expands the SAPTreeView object to a specified path and opens the context 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 | Expands the SAPTreeView object and clicks the last item in the path. |
| SelectMenuItem | Selects the specified menu item from the drop-down menu. |
| SetTOProperty | Sets the value of the specified description property in the test object description. |
| Submit | Submits a form. |
| Swipe | Swipes the object. |
| ToString | Returns a string that represents the test object. |
| WaitProperty | Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step. |
Properties
 Exist | Checks whether the object currently exists in the open application. |
| Object | Accesses the native methods and properties of the object. |
Activate Method
Description
Expands the SAPTreeView object and double-clicks the last item in the path.
Syntax
object.Activate (Value, [Column])
Arguments
| Parameter | Description |
|---|---|
| Value |
Required. A String value.
The path of the tree view object. Each item in the path can be a name or index number in the format #index.
Index values begin with 1.
|
| Column |
Optional. A String value. The column number in the format #index or the column header label.
Index values begin with 1.
Default value = "#1" |
Return Type
None.
IMPORTANT
You can use the column to select a specific column in a multi-column SAPTreeView object.
Example
Expand a Specific Tree View Object Using the Item Name (VBScript)
'The following example uses the Activate method to expand the "Demonstration" tree view object
'using the specified path and to activate (double-click) the "Table control" item.
Browser("ITS System Informati").Page("EnjoySAP Demo").SAPTreeView("Demonstration").Activate "Workbench Demos; Interface elements;Table control"Expand a Specific Tree View Object Using the Index (VBScript)
'The following example uses the Activate method to expand the "Demonstration" tree view object
'using index numbers instead of item names and to activate (double-click) the "Table control" item.
Browser("ITS System Informati").Page("EnjoySAP Demo").SAPTreeView("Demonstration").Activate "#1;Interface elements;#1"
ChildItem Method
Description
Returns a test object from a tree node by type and index.
Syntax
object.ChildItem (Value, Column, MicClass, Index)
Arguments
| Parameter | Description |
|---|---|
| Value |
Required. A String value.
The path of the tree view object. Each item in the path can be a name or index number in the format #index.
Index values begin with 1.
|
| Column |
Required. A String value. The column number in the format #index or the column header label.
Index values begin with 1.
|
| MicClass |
Required. A String value. Object type. |
| Index |
Required. A long integer value. Index of the object of type TO_Class in the tree. It is used to specify the desired element when there is more then one object of type TO_Class in the tree. The first object has an index of 0. |
Return Type
An Object.
IMPORTANT
You must perform an Expand method before performing a ChildItem method. Otherwise, the test run fails.
When a ChildItem method is performed on a node with child items, the value of the Index argument is not always as it appears in the Object Spy (index values vary according to your specific SAP Gui for HTML application implementation).
Example
Select a Link Object in a Tree (VBScript)'The following example uses the ChildItem method to select the first link object in the '"Objecte > DynPros > 0100MUELLER…" tree. Browser("ITS System Informati").Page("EnjoySAP Demo").SAPTreeView("Demonstration").ChildItem("Objecte;DynPros;0100MUELLER…", "#1", "link", 0).Click
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. Note that 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 click. Note that 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 for the x and y argument values if you want to enter a value for the button argument without specifying x- and y- coordinates for the click. 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 an Edit Box (VBScript)'The following example uses the Click method on the "Manufacturer" edit box. Browser("ITS System Informati").Page("User Interface_7").SAPEdit("Manufacturer").Click
Click a Specific Button (VBScript)'The following example uses the Click method to click the "SAP Business" button 'in the "SAPGUI for HTML" page. Browser("SAPGUI for HTML").Page("SAPGUI for HTML").SAPFrame("SAP Easy Access").SAPButton("SAP Business").Click
Collapse Method
Description
Collapses the specified path of the SAPTreeView object during the test run.
Syntax
object.Collapse (Value)
Arguments
| Parameter | Description |
|---|---|
| Value |
Required. A String value.
The path of the tree view object. Each item in the path can be a name or index number in the format #index.
Index values begin with 1.
|
Return Type
None.
Example
Collapse a Specific Named Path in a Tree (VBScript)'The following example uses the Collapse method to collapse the "Workbench Demos" path in the '"Demonstration" tree view object during the test run. Browser("ITS System Informati").Page("EnjoySAP Demo").SAPTreeView("Demonstration").Collapse "Workbench Demos"
Collapse a Specific Numbered Path in a Tree (VBScript)'The following example uses the Collapse method to collapse the first path in the "Demonstration" 'tree view object during the test run. Browser("ITS System Informati").Page("EnjoySAP Demo").SAPTreeView("Demonstration").Collapse "#1"
DoubleClick Method
Description
Clicks on the object twice.
Syntax
object.DoubleClick ([interval], [x], [y])
Arguments
| Parameter | Description |
|---|---|
| interval |
Optional. A double floating value. The number of seconds between the two clicks. The default value is 0.2 seconds. |
| x |
Optional. A long 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 = -9999 |
| y |
Optional. A long 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 = -9999 |
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 a Specific Button (VBScript)'The following example uses the DoubleClick method to click the "SAP Business" button 'in the "SAPGUI for HTML" page. Browser("SAPGUI for HTML").Page("SAPGUI for HTML").SAPFrame("SAP Easy Access").SAPButton("SAP Business").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. A long integer value. Default value = -9999 |
| y |
Optional. A long integer value. Default value = -9999 |
| BUTTON |
Optional. A predefined constant or number. Default value = micLeftBtn |
| Modifier |
Optional. A String value. Default value = 0 |
Return Type
None
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. Default value = -9999 |
| y |
Optional. A long integer value. Default value = -9999 |
Return Type
None
Expand Method
Description
Expands the SAPTreeView object to the specified path during the test run.
Syntax
object.Expand (Value)
Arguments
| Parameter | Description |
|---|---|
| Value |
Required. A String value.
The path of the tree view object. Each item in the path can be a name or index number in the format #index.
Index values begin with 1.
|
Return Type
None.
Example
Expand a Specific Named Path in a Tree (VBScript)'The following example uses the Expand method to expand the "Workbench Demos > Interface elements > Table control" 'path in the "Demonstration" tree view object during the test run. Browser("ITS System Informati").Page("EnjoySAP Demo").SAPTreeView("Demonstration").Expand "Workbench Demos; Interface elements;Table control"
Expand a Specific Numbered Path in a Tree (VBScript)'The following example uses the Expand method to expand the "1st > 8th > Table control" path in the '"Demonstration" tree view object during the test run. Browser("ITS System Informati").Page("EnjoySAP Demo").SAPTreeView("Demonstration").Expand "#1;#8;Table control"
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. Default value = micLeftBtn |
Return Type
None
Example
Simulate an Event on a Button (VBScript)'The following example uses the FireEvent method to simulate the "onmouseover" event 'on the "Tools" button. Browser("SAP R/3 System").Page("SAP R/3 System").SAPFrame("SAP R/3 System").SAPButton("Tools").FireEvent "onmouseover"
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. A long 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 = -9999 |
| y |
Optional. A long 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 = -9999 |
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.
Example
Hover Over or Tap a WebElement (VBScript)The following example uses the HoverTap method on a form. 'When hover is supported, such as on a desktop, a hover action is performed. 'When hover is not supported, such as on a mobile device, a tap is performed instead. Browser("New Page").Page("New Page").WebElement("html tag:=Form").HoverTap
LongPress Method
Description
Presses and holds the object.
Syntax
object.LongPress [duration], [x], [y]
Arguments
| Parameter | Description |
|---|---|
| duration |
Optional. A double floating value. The time period (in seconds) to hold the long tap gesture. You can specify partial seconds as a duration time. Default value = 1 |
| x |
Optional. A long integer value. The x-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 = -9999 |
| y |
Optional. A long 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 = -9999 |
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.
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
OpenContextMenu Method
Description
Expands the SAPTreeView object to a specified path and opens the context menu.
Syntax
object.OpenContextMenu (Value, [Column])
Arguments
| Parameter | Description |
|---|---|
| Value |
Required. A String value.
The path of the tree view object. Each item in the path can be a name or index number in the format #index.
Index values begin with 1.
|
| Column |
Optional. A String value. The column number in the format #index or the column header label.
Index values begin with 1.
Default value = "#1" |
Return Type
None.
Example
Use the Context Menu to Open a New Folder (VBScript)'The following example uses the OpenContextMenu method to open the context menu 'of the "Business Objects" node in the "Portal Catalog" SAPTreeView and then to open 'a new folder in the content area. Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").Frame("/irj/servlet/prt/portal/prtroo").SAPTreeView("Portal Catalog").OpenContextMenu "Business Objects" Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").Frame("/irj/servlet/prt/portal/prtroo").SAPTreeView("Portal Catalog").SelectMenuItem "New;Folder" Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").Sync
Pan Method
Description
Perform a pan gesture.
Syntax
object.Pan (deltaX, deltaY, [duration], [startX], [startY])
Arguments
| Parameter | Description |
|---|---|
| deltaX |
Required. A long integer value. The distance moved on the x-axis, relative to the start point. |
| deltaY |
Required. A long integer value. The distance moved on the y-axis, relative to the start point. |
| duration |
Optional. A double floating value. The number of seconds required to perform the pan gesture. Default value = 0.5 |
| startX |
Optional. A long integer value. The x-coordinate of where the pan gesture starts. The specified coordinates are relative ot the upper left corner of the object. Default value = -9999 |
| startY |
Optional. A long 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 = -9999 |
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.
This method is not supported in Internet Explorer and older versions of FireFox.
Example
Pan across a SAPTable element (VBScript)'The following example performs a Pan gesture on a SAPTable object. Browser("ITS System Informati").Page("Table control").SAPTable("1x1").Pan 564, 507
Pinch Method
Description
Perform a pinch gesture.
Syntax
object.Pinch (scale, [duration], [x], [y])
Arguments
| Parameter | Description |
|---|---|
| scale |
Required. A double floating value. The zoom scale resulting from the pinch gesture. This is the ratio between the distance between the fingers at the end of the pinch gesture to the distance between the fingers at the beginning of the pinch gesture. |
| duration |
Optional. A double floating value. The number of seconds required to perform the pinch gesture. The default value is 1 second. Default value = 1 |
| x |
Optional. A long integer value. The x-coordinate of where the pinch 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 = -9999 |
| y |
Optional. A long integer value. The y-coordinate of of where the pinch 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 = -9999 |
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.
This method is not supported in Internet Explorer and older versions of FireFox.
Example
Pinch a SAPTable object (VBScript)'The following example performs a Pinch gesture to zoom in on a SAPTable object. Browser("ITS System Informati").Page("Table control").SAPTable("1x1").Pinch 2.5
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 SAPTreeView object and clicks the last item in the path.
Syntax
object.Select (Value, [Column])
Arguments
| Parameter | Description |
|---|---|
| Value |
Required. A String value.
The path of the tree view object. Each item in the path can be a name or index number in the format #index.
Index values begin with 1.
|
| Column |
Optional. A String value. The column number in the format #index or the column header label.
Index values begin with 1.
Default value = "#1" |
Return Type
None.
IMPORTANT
You can use the column to select a specific column in a multi-column SAPTreeView object.
Example
Expand a Specific Named Path and Select an Item (VBScript)'The following example uses the Select method to expand the "Demonstration" tree view object 'using the specified path and to select (click) the "Table control" item. Browser("ITS System Informati").Page("EnjoySAP Demo").SAPTreeView("Demonstration").Select "Workbench Demos; Interface elements;Table control"
Expand a Specific Numbered Path and Select an Item (VBScript)'The following example uses the Select method to expand the "Demonstration" tree view object 'using index numbers to select (click) the "Table control" item. Browser("ITS System Informati").Page("EnjoySAP Demo").SAPTreeView("Demonstration").Select "#1;Interface elements;#1"
Expand a Specific Path and Select a Named Column (VBScript)'The following example uses the Select method to expand the "Demonstration" tree view object 'using the specified path and to select (click) the "Report/Transaction" column. Browser("ITS System Informati").Page("EnjoySAP Demo").SAPTreeView("Demonstration").Select "Workbench Demos;Interface elements;Table control", "Report/Transaction"
Expand a Specific Path and Select a Numbered Column (VBScript)'The following example uses the Select method to expand the "Demonstration" tree view object 'using the specified path and to select (click) the second column. Browser("ITS System Informati").Page("EnjoySAP Demo").SAPTreeView("Demonstration").Select "Workbench Demos;Interface elements;Table control", "#2"
SelectMenuItem Method
Description
Selects the specified menu item from the drop-down menu.
Syntax
object.SelectMenuItem (MenuPath)
Arguments
| Parameter | Description |
|---|---|
| MenuPath |
Required. A String value. The menu item name, full path, or numeric index can denote the item. Index values begin with 1. For a full path, separate items with semicolons (;). |
Return Type
None.
Example
Open a New Folder in the Content Area (VBScript)'The following example uses the SelectMenuItem method to open a new folder in the content area. Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").Frame("/irj/servlet/prt/portal/prtroo").SAPTreeView("Portal Catalog").OpenContextMenu "Business Objects" Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").Frame("/irj/servlet/prt/portal/prtroo").SAPTreeView("Portal Catalog").SelectMenuItem "New;Folder" Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").Sync
Submit Method
Description
Submits a form.
Syntax
object.Submit
Return Type
None.
Example
Submit a Form Using a Specific Edit Box (VBScript)'The following example uses the Submit method to submit a form using the "Manufacturer" edit box. Browser("ITS System Informati").Page("User Interface_7").SAPEdit("Manufacturer").Submit
Submit a Form (VBScript)'The following example uses the Submit method to submit a form using the "Manufacturer" button. Browser("ITS System Informati").Page("User Interface_7").SAPButton("Manufacturer").Submit
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. A long integer value. The distance (in pixels) of the swipe gesture. Default value = 200 |
| duration |
Optional. A double floating value. The time period (in seconds) of the swipe gesture. You can specify partial seconds as a duration time. Default value = 0.25 |
| startX |
Optional. A long 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 = -9999 |
| startY |
Optional. A long 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 = -9999 |
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 for Windows Phone.
Example
Swipe a TreeView Object (VBScript)'The following example performs a Swipe gesture on a SAPTreeView object. Browser("ITS System Informati").Page("EnjoySAP Demo").SAPTreeView("Demonstration").Swipe moveDown,200,1,75,75
See also:
