Share this page
SAPNavigationBar Object
Description
Presses and holds the object.
IMPORTANT
An iPanel is divided into sections, represented by expandable strips. Each strip contains a hierarchical tree of items.
Operations
The sections below list the built-in methods and properties that you can use as operations for the SAPNavigationBar object.
Note: You can also view a list and descriptions of the SAPNavigationBar 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 specified path of the SAPNavigationBar tree 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 iPanel 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. |
| Hide | Hides the iPanel. |
| 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. |
| 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. |
| Relate | Uses the SAP Enterprise Portal Drag & Relate feature to drag and drop a selected item onto the last node in the path of an iPanel. |
| RightClick | Right-clicks the object. |
| Select | Expands all items in the path of the iPanel and clicks the last item in the path. |
| SetTOProperty | Sets the value of the specified description property in the test object description. |
| Show | Displays the iPanel. |
| 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. |
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").ClickClick 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 SAPNavigationBar tree during the test run.
Syntax
object.Collapse (Path)
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value.
The path of the iPanel item, i.e., the strip items separated by semicolons (;).
|
Return Type
None.
IMPORTANT
This method can be performed only on a tree inside a navigation bar strip; not on a strip itself. (A strip can be collapsed by selecting a different strip.)
This method is not recorded. You can include it in your test by using the Step Generator or inserting it directly in the Keyword View or Editor. For more information, refer to the Unified Functional Testing User Guide.
Example
Collapse a Node in the Navigation Bar (VBScript)
'The following example uses the Collapse method to click the collapse (-) icon related to
'the last node in the path of the navigation bar tree object. (This collapses the tree
'within a specific strip, but does not collapse the strip itself.)
Browser("Browser").Page("SAP Enterprise").Frame("ToolBar").SAPNavigationBar("SAPNavigationBar").Collapse "My Portal;Personal Folder"
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 UFT Mobile, 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 iPanel to the specified path during the test run.
Syntax
object.Expand (Path)
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value.
The path of the iPanel item, i.e., the strip items separated by semicolons (;).
|
Return Type
None.
IMPORTANT
This method is not recorded. You can include it in your test by using the Step Generator or inserting it directly in the Keyword View or Editor. For more information, refer to the Unified Functional Testing User Guide.
Example
Expand a Node in the Navigation Bar (VBScript)
'The following example uses the Expand method to expand the "My Portal > Personal Folder"
'strip in the iPanel during the test run.
Browser("Browser").Page("SAP Enterprise").Frame("ToolBar").SAPNavigationBar("SAPNavigationBar").Expand "My Portal;Personal Folder"
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"
Hide Method
Description
Hides the iPanel.
Syntax
object.Hide
Return Type
None.
IMPORTANT
This method is not recorded. You can include it in your test by using the Step Generator or inserting it directly in the Keyword View or Editor. For more information, refer to the Unified Functional Testing User Guide.
Example
Hide the Navigation Bar (VBScript)
'The following example uses the Hide method to hide the iPanel during the test run.
Browser("Browser").Page("SAP Enterprise_2").Frame("ToolBar").SAPNavigationBar("SAPNavigationBar").Hide
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 UFT Mobile, 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 supoprted, 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 UFT Mobile 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
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 UFT Mobile, 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 UFT Mobile, 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
Relate Method
Description
Uses the SAP Enterprise Portal Drag & Relate feature to drag and drop a selected item onto the last node in the path of an iPanel.
Syntax
object.Relate (Path)
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value.
The path of the navigation bar item. Each item in the path can be a name or index number in the format #index.
Index values begin with 1.
|
Return Type
None.
IMPORTANT
If necessary, this method also displays the iPanel if it is hidden, and expands any closed nodes in the path.
Note: You must perform an ondragstart event on the item you want to drag before performing the Relate method.
Example
Drag a Link and Drop it into a Node (VBScript)
'The following example uses the Relate method to drag the "My Folder" link and drop it onto the
'"My Portal > Personal Folder" node of the iPanel.
Browser("Browser").Page("SAP Enterprise").Frame("TopLevelNavigation").Link("My Folder").FireEvent "ondragstart"
Browser("Browser").Page("SAP Enterprise").Frame("ToolBar").SAPNavigationBar("SAPNavigationBar").Relate "My Portal;Personal Folder"
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 all items in the path of the iPanel and clicks the last item in the path.
Syntax
object.Select (Path)
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value.
The path of the navigation bar item. Each item in the path can be a name or index number in the format #index.
Index values begin with 1.
|
Return Type
None.
IMPORTANT
If the iPanel is hidden, this method also displays it.
Example
Select a Node from the Navigation Bar (VBScript)
'The following example uses the Select method to select the "Examples of User Interface Design (BIBS)" node of
'the iPanel, under the specified path ("R3 4.6C - Calderone > MI6 System - Web GUI Roles").
Browser("Browser").Page("SAP Enterprise_2").Frame("ToolBar").SAPNavigationBar("SAPNavigationBar").Select "R3 4.6C - Calderone;MI6 System - Web GUI Roles;Examples of User Interface Design (BIBS)"
Show Method
Description
Displays the iPanel.
Syntax
object.Show
Return Type
None.
IMPORTANT
This method is not recorded. You can include it in your test by using the Step Generator or inserting it directly in the Keyword View or Editor. For more information, refer to the Unified Functional Testing User Guide.
Example
Show the Navigation Bar (VBScript)
'The following example uses the Show method to display the iPanel during the test run.
Browser("Browser").Page("SAP Enterprise").Frame("ToolBar").SAPNavigationBar("SAPNavigationBar").Show
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").SubmitSubmit 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 UFT Mobile 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 Navigation Bar (VBScript)
'The following example performs a Swipe gesture on a SAPNavigationBar object.
Browser("Browser").Page("SAP Enterprise").Frame("ToolBar").SAPNavigationBar("SAPNavigationBar").Swipe moveDown,200,1,75,75
See also:
