Share this page
SAPNWBC Object
Description
A SAP NWBC navigation control, which can be used to nativate to different SAP modules.
Operations
The sections below list the built-in methods and properties that you can use as operations for the SAPNWBC object.
Note: You can also view a list and descriptions of the SAPNWBC 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. |
| DetailedNavigation | Navigates the detailed navigation in the navigation panel. |
| Drag | Performs the 'drag' part of a drag and drop operation. |
| Drop | Performs the 'drop' part of a drag and drop operation. |
| FireEvent | Triggers an event. |
| GetROProperty | Returns the current value of the 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. |
| Navigate | Navigates the tabs in the top-level navigation bar. |
| Output | Retrieves the current value of an item and stores it in a specified location. |
| 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. |
| 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. An 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 = 0 |
| y |
Optional. An 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 = 0 |
| 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
DetailedNavigation Method
Description
Navigates the detailed navigation in the navigation panel.
Syntax
object.DetailedNavigation path
Arguments
| Parameter | Description |
|---|---|
| path |
Required. A String value.
The path of the tab item, separated by semicolons (;). You can use either the tab name, or its index. For example, TabName;SubTabName or #1;#2.
Index values begin with 1.
|
Return Type
None
IMPORTANT
The SAPNWBC navigation control in the application may load slowly when running this method. If an error occurs during the test run, add a Wait step before the method.
Example
Navigate Using the Detailed Navigation Bar (VBScript)
'The following example uses the DetailedNavigation method to navigate to the "Stock Overview" panel
'using the Detailed Navigation bar.
Browser("SAPNWBC").Page("SAPNWBC").SAPNWBC("NWBC").Navigate "Inventory Controlling"
Browser("SAPNWBC").Page("SAPNWBC").SAPNWBC("NWBC").DetailedNavigation "Stock Overview"
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. Default value = 0 |
| y |
Optional. An integer value. Default value = 0 |
| BUTTON |
Optional. A predefined constant or number. Default value = micLeftBtn |
| Modifier |
Optional. A String value. |
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. An integer value. Default value = 0 |
| y |
Optional. An integer value. Default value = 0 |
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. 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"
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. The default value is the center of the object. Default value = 0 |
Return Type
None
Navigate Method
Description
Navigates the tabs in the top-level navigation bar.
Syntax
object.Navigate path
Arguments
| Parameter | Description |
|---|---|
| path |
Required. A String value. The path of the node, separated by semicolons (;). You can use either the node name, or its index. For example, NodeName;SubNodeName or #1;#2.
Index values begin with 1.
|
Return Type
None
Example
Navigate Using the Top Level Navigation Bar (VBScript)
'The following example uses the Navigate method to navigate to the "Inventory Controlling" panel
'using the top-level navigation bar.
Browser("SAPNWBC").Page("SAPNWBC").SAPNWBC("NWBC").Navigate "Inventory Controlling"
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
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
See also:
