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

Common Method CaptureBitmapSaves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjectsReturns the collection of child objects contained within the object.
Common Method GetAllROProperties

Returns the collection of properties and current values from the object in the application.

Method ClickClicks the object.
Method DetailedNavigationNavigates the detailed navigation in the navigation panel.
Method DragPerforms the 'drag' part of a drag and drop operation.
Method DropPerforms the 'drop' part of a drag and drop operation.
Method FireEventTriggers an event.
Common Method GetROPropertyReturns the current value of the description property from the object in the application.
Common Method GetTOPropertiesReturns the collection of properties and values used to identify the object.
Common Method GetTOPropertyReturns the value of the specified description property from the test object description.
Common Method HighlightHighlights the object in the application.
Method MiddleClickMiddle-clicks the object.
Method NavigateNavigates the tabs in the top-level navigation bar.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method RightClickRight-clicks the object.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Method SubmitSubmits a form.
Common Method ToStringReturns a string that represents the test object.
Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property ExistChecks whether the object currently exists in the open application.
Common Property ObjectAccesses the native methods and properties of the object.

Back to top

 

Click Method

Description

Clicks the object.

Syntax

object.Click [x], [y], [BUTTON]

Arguments

ParameterDescription
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

Back to top

 

DetailedNavigation Method

Description

Navigates the detailed navigation in the navigation panel.

Syntax

object.DetailedNavigation path

Arguments

ParameterDescription
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

Back to top

 

Drag Method

Description

Performs the 'drag' part of a drag and drop operation.

Syntax

object.Drag [x], [y], [BUTTON], [Modifier]

Arguments

ParameterDescription
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

Back to top

 

Drop Method

Description

Performs the 'drop' part of a drag and drop operation.

Syntax

object.Drop [x], [y]

Arguments

ParameterDescription
x Optional. An integer value.

Default value = 0
y Optional. An integer value.

Default value = 0

Return Type

None

Back to top

 

FireEvent Method

Description

Triggers an event.

Syntax

object.FireEvent EventName, [x], [y], [BUTTON]

Arguments

ParameterDescription
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

Back to top

 

MiddleClick Method

Description

Middle-clicks the object.

Syntax

object.MiddleClick [x], [y]

Arguments

ParameterDescription
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

Back to top

 

Navigate Method

Description

Navigates the tabs in the top-level navigation bar.

Syntax

object.Navigate path

Arguments

ParameterDescription
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

Back to top

 

RightClick Method

Description

Right-clicks the object.

Syntax

object.RightClick [x], [y]

Arguments

ParameterDescription
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

Back to top

 

Submit Method

Description

Submits a form.

Syntax

object.Submit

Return Type

None

Example

Back to top

See also: