Object Model Reference for GUI Testing > SAP Web > Click Method

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

Common Method CaptureBitmap Saves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method Check Checks whether the actual value of an item matches the expected value.
Common Method CheckProperty Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjects Returns the collection of child objects contained within the object.
Method Click Clicks the object.
Method Collapse Collapses the specified path of the SAPNavigationBar tree during the test run.
Method DoubleClick Clicks on the object twice.
Method Drag Performs the 'drag' part of a drag and drop operation.
Method Drop Performs the 'drop' part of a drag and drop operation.
Method Expand Expands the iPanel to the specified path during the test run.
Method FireEvent Triggers an event.
Common Method GetROProperty Returns the current value of the description properties from the object in the application.
Common Method GetTOProperties Returns the collection of properties and values used to identify the object.
Common Method GetTOProperty Returns the value of the specified description properties from the test object description.
Method Hide Hides the iPanel.
Method HoverTap When hover is supported, places the pointer on the object. Otherwise, taps the object.
Method LongPress Presses and holds the object.
Method MiddleClick Middle-clicks the object.
Common Method Output Retrieves the current value of an item and stores it in a specified location.
Method Pan Perform a pan gesture.
Method Pinch Perform a pinch gesture.
Common Method RefreshObject Instructs UFT to re-identify the object in the application the next time a step refers to this object.
Method 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.
Method RightClick Right-clicks the object.
Method Select Expands all items in the path of the iPanel and clicks the last item in the path.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Method Show Displays the iPanel.
Method Submit Submits a form.
Method Swipe Swipes the object.
Common Method ToString Returns a string that represents the test object.
Common Method WaitProperty Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property Exist Checks whether the object currently exists in the open application.
Common Property Object Accesses the native methods and properties of the object.

 

Back to top

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


 

Back to top

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


 

Back to top

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.
Default value = 0.200000002980232
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

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

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


 

Back to top

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


 

Back to top

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


 

Back to top

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


 

Back to top

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


 

Back to top

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 Mobile Center, 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


 

Back to top

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 Mobile Center or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.


 

Back to top

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


 

Back to top

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 Mobile Center, 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


 

Back to top

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 Mobile Center, 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


 

Back to top

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


 

Back to top

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


 

Back to top

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


 

Back to top

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


 

Back to top

Submit Method

Description

Submits a form.

Syntax

object.Submit

Return Type

None.

Example


 

Back to top

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:

  • moveDown
  • moveLeft
  • moveRight
  • moveUp
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 Mobile Center 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


Back to top

See also: