SAPWDJMenu Object
Description
A SAPWDJ menu control.
IMPORTANT
The SAPWDJMenu test object class extends the WebElement test object class and inherits many of its operations and description properties.
Operations
The sections below list the built-in methods and properties that you can use as operations for the SAPWDJMenu object.
Note: You can also view a list and descriptions of the SAPWDJMenu 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, depending on the specified file extension. |
Check | Checks whether the actual value of an item matches the expected value. |
CheckProperty | Checks whether the specified object property achieves the specified 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. |
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. |
FireEvent | Triggers an event. |
GetROProperty | Returns the current value of the specified 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. |
OpenMenu | Expands the menu according to the specified path |
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 menu according to the specified path and clicks the last item in the path. |
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 current 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. 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. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the click. 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
IMPORTANT
- UFT One does not record the Click methhod for right- or middle-clicks. Insetad, UFT One records the RightClick and MiddleClick methods.
- Recording options for this method are defined in the Web > Advanced pane of the Options dialog box (Tools > Options > GUI Testing tab > Web > Advanced node). For details, see the section on the Web > Advanced pane in the UFT One Add-ins Guide.
- For some Mozilla Firefox objects, this method is recorded only if a handler is present.
Example
'The following example clicks an SAPWDJMenu object. Browser("Service Registry").Page("Service Registry").SAPWDJMenu("Service Registry").Click 75,75
DoubleClick Method
Description
Clicks on the object twice.
Syntax
object.DoubleClick [interval], [x], [y]
Arguments
Parameter | Description |
---|---|
interval |
Optional. A Variant. The number of seconds between the two clicks. The default value is 0.2 seconds. |
x |
Optional. An 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 = 0 |
y |
Optional. An 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 = 0 |
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.
- If you are testing a web or hybrid application on a mobile device, this method is equivalent to performing the DoubleTap gesture.
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. The x-coordinate within the source object. Default value = 0 |
y |
Optional. An integer value. The y-coordinate within the source object. Default value = 0 |
BUTTON |
Optional. A predefined constant or number. The mouse button used to drag the object. (Releasing the button performs the Drop operation.) Default value = micLeftBtn |
Modifier |
Optional. A String value. The keyboard modifier that is pressed during the Drag operation. Possible values:
|
Return Type
None
Example
'The following example drags an SAPWDJMenu object. Browser("Service Registry").Page("Service Registry").SAPWDJMenu("Service Registry").Drag 75,75s
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. The x-coordinate of the target object on which the dragged object is dropped. If the dragged and dropped object is the same object, then the x-coordinate is relative to the upper left corner in the source location prior to being dragged. Default value = 0 |
y |
Optional. An integer value. The y-coordinate of the target object on which the dragged object is dropped. If the dragged and dropped object is the same object, then the y-coordinate is relative to the upper left corner in the source location prior to being dragged. Default value = 0 |
Return Type
None
IMPORTANT
- Drag and Drop operations are performed as a coupled step. Inserting one operation without the other causes an error to occur. For more informatoin on Drag and Drop operations, see Drag Method.
- This test object method is not supported on Safari browsers.
Example
'The following example drops a dragged SAPWDJMenu object. Browser("Service Registry").Page("Service Registry").SAPWDJMenu("Service Registry").Drop 90,100
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. Available events: onchange, onclick, ondblclick, onblur, onfocus, onmousedown, onmouseup, onmouseover, onmouseout, onsubmit, onreset, onpropertychange. |
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. The mouse button used to fire the object. Default value = micLeftBtn |
Return Type
None
Example
'The following example fires the onclick event for a SAPWDJMenu object. Browser("Service Registry").Page("Service Registry").SAPWDJMenu("Service Registry").FireEvent "onclick"
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. An 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 = 0 |
y |
Optional. An 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 = 0 |
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.
LongPress Method
Description
Presses and holds the object.
Syntax
object.LongPress [duration], [x], [y]
Arguments
Parameter | Description |
---|---|
duration |
Optional. A Variant. The time period (in seconds) to hold the long tap gesture. You can specify partial seconds as a duration time. |
x |
Optional. An integer value. The x-coordinate of the long 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 = 0 |
y |
Optional. An 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 = 0 |
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.
Example
'The following example performs a LongPress on a SAPWDJ object. Device("Device").App("HPE Mobile Web_2").MobileWebView("Web View").Page("Checkbox and radio inputs").SAPWDJMenu("Service Registry").LongPress 1,75,75
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
IMPORTANT
- If UFT One does not record the MiddleClick method, it may be due to Web Event Recording Configuration settings that were preserved from the upgrade of a previous UFT One version. In this case, you can enable recording of these methods by resetting the Web Event Recording Configuration to a preconfigured level. For details, see the section on the Custom Event Recording Configuration dialog box in the UFT One Add-ins Guide.
- When Event Replay is selected for the Replay type option in the Web > Advanced pane of the Options dialog box (Tools > Options > GUI Testing tab > Web > Advanced node), UFT One fires onmousedown, focus, and onmouseup, events for this method, which may cause slightly different behavior than the regular Click Method with a micMiddleButton value for the Button argument.
Example
'The following example clicks the middle mouse button on a SAPWDJMenu object. Browser("Service Registry").Page("Service Registry").SAPWDJMenu("Service Registry").MiddleClick
OpenMenu Method
Description
Expands the menu according to the specified path
Syntax
object.OpenMenu [Path]
Arguments
Parameter | Description |
---|---|
Path |
Optional. A String value. The names or indexes of the menu items to open in order to expand the required item, separated by semicolons (;). To specify an index, use the format "#N", where N is the numeric value. NOTE: The last item in the path is the menu to expand. This method does not select a menu item. |
Return Type
None
IMPORTANT
This method is not recorded.
Example
'The following example opens a SAPWDJMenu object and then runs a checkpoint on the menu. Browser("Home - SAP NetWeaver Administr").Page("Home - SAP NetWeaver Administr").SAPWDJMenu("SAPWDJMenu").OpenMenu "My Entry Page" Browser("Home - SAP NetWeaver Administr").Page("Home - SAP NetWeaver Administr").SAPDropDownMenu("Set current page as entry").Check CheckPoint("Set current page as entry page")
'The following example opens a sub-menu item and performs a checkpoint on the SAPWDJMenu object. Browser("Home - SAP NetWeaver Administr").Page("Home - SAP NetWeaver Administr").SAPWDJMenu("SAPWDJMenu").OpenMenu "My Entry Page;Set current page as entry page" Browser("Home - SAP NetWeaver Administr").Page("Home - SAP NetWeaver Administr").SAPDropDownMenu("SAPWDJMenu").Check CheckPoint("Set current page as entry page")
The following example opens a menu item. Browser("Home - SAP NetWeaver Administr").Page("Home - SAP NetWeaver Administr").SAPWDJMenu("SAPWDJMenu").OpenMenu "#2;#2;#3"
Pan Method
Description
Perform a pan gesture.
Syntax
object.Pan deltaX, deltaY, [duration], [startX], [startY]
Arguments
Parameter | Description |
---|---|
deltaX |
Required. An integer value. The distance moved on the x axis, relative to the start point. |
deltaY |
Required. An integer value. The distance moved on the y axis, relative to the start point. |
duration |
Optional. A Variant. The number of seconds required to peform the pan gesture. |
startX |
Optional. An integer value. The x-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 = 0 |
startY |
Optional. An 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 = 0 |
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 in Internet Explorer and older versions of FireFox.
Pinch Method
Description
Perform a pinch gesture.
Syntax
object.Pinch scale, [duration], [x], [y]
Arguments
Parameter | Description |
---|---|
scale |
Required. A Variant. 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 Variant. The number of seconds required to perform the pinch gesture. The default value is 1 second. |
x |
Optional. An 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 = 0 |
y |
Optional. An integer value. The y-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 = 0 |
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 in Internet Explorer and older versions of FireFox.
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
IMPORTANT
- If UFT One does not record the RightClick method, it may be due to Web Event Recording Configuration settings that were preserved from the upgrade of a previous UFT One version. In this case, you can enable recording of these methods by resetting the Web Event Recording Configuration to a preconfigured level. For details, see the section on the Custom Web Event Recording Configuration dialog box in the UFT One Add-ins Guide.
- When Event Replay is selected for the Replay type option in the Web > Advanced pane of the Options dialog box (Tools > Options > GUI Testing tab > Web > Advanced node), UFT One fires onmousedown, onfocus, onmouseup, and oncontextmenu events for this method, which may cause slightly different behavior than the regular Click Method with a micRightButton value for the Button argument.
Example
'The following example displays the context menu for a SAPWDJMenu object. Browser("Service Registry").Page("Service Registry").SAPWDJMenu("Service Registry").RightClick
Select Method
Description
Expands the menu according to the specified path and clicks the last item in the path.
Syntax
object.Select Path
Arguments
Parameter | Description |
---|---|
Path |
Required. A String value. The names or indexes of the menu items to open in order to reach the required item, separated by semicolons (;). To specify an index, use the format "#N", where N is the numeric value. |
Return Type
None
Example
'The following example selects an item from a SAPWDJMenu object. Browser("Service Registry").Page("Service Registry").SAPWDJMenu("Service Registry").Select "Time Zone;System Time Zone"
'The following example selects an item from a SAPWDJMenu object. Browser("Service Registry").Page("Service Registry").SAPWDJMenu("Service Registry").Select "#1"
Submit Method
Description
Submits a form.
Syntax
object.Submit
Return Type
None
IMPORTANT
This method simulates pressing the Enter key, while the focus is on the object specified in the statement.
If the object is not part of a Web form, the Submit method has no effect.
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. An integer value. The distance (in pixels) of the swipe gesture. Default value = 0 |
duration |
Optional. A Variant. The time period (in seconds) of the swipe gesture. You can specify partial seconds as a duration time. |
startX |
Optional. An 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 = 0 |
startY |
Optional. An 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 = 0 |
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 on Windows Phone.
Example
'The following example performs a Swipe gesture on a SAPWDJMenu object. Device("Device").App("HPE Mobile Web_2").MobileWebView("Web View").Page("Checkbox and radio inputs").SAPWDJMenu("Service Registry").Swipe moveDown,200,1,75,75
See also: