Object Model Reference for GUI Testing > Web > Click Method

WebTree Object

Description

A tree control in a Web site or application

IMPORTANT

Operations

The sections below list the built-in methods and properties that you can use as operations for the WebTree object.

Note: You can also view a list and descriptions of the WebTree 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, depending on the specified file extension.
Common Method Check Checks whether the actual value of an item matches the expected value.
Common Method CheckProperty Checks whether the specified object property achieves the specified 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 Collapse the tree to a specific item based on the specified path.
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 Expand the tree to a specific item based on the specified path.
Method FireEvent Triggers an event.
Common Method GetROProperty Returns the current value of the specified 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 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 RightClick Right-clicks the object.
Method Select Select an item in the tree.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Method Submit Submits a form.
Method Swipe Swipes the object.
Common Method ToString Returns a string that represents the current 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. The specified coordinates are relative to the upper left corner 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
button Optional. A predefined constant or number.
The mouse button used to click the object.
Default value = micLeftBtn

Return Type

None

IMPORTANT

Example


 

Back to top

Collapse Method

Description

Collapse the tree to a specific item based on the specified path.

Syntax

object.Collapse (itemPath, [XPathToOpener] [doDblClickOnOpener)

Arguments

Parameter Description
itemPath Required. A String value.

The item to collapse. The value can either be one of the items in the list or an index. To specify the index of the item to select, use "#N". Index values begin with 0.

XPathToOpener Optional. A String value.

The path to the node which collapses the tree item, relative to the tree item root element.

For example, if you trying to expand/collapse a node that does not work:

  1. Spy on the icon that expands or collapses the tree.
  2. Retrieve the xpath of the expander node, such as //LI[@id="apples"]/IMG[1]. Note that the tree item root XPath is //LI[@id="apples"]
  3. Use a relative xpath based for the XPath argument, based on the tree item's place in the hierarchy. For example, IMG[1]

When you are done, the test step is WebTree.Collapse "node A; node B", "IMG[1]".


Default value = ""
doDblClickOnOpener

Optional. A string value.

Instructs UFT to open a tree element with a double click.

Possible values:

  • TRUE: automatically performs a double-click to collapse the tree element
  • FALSE: performs a single click on the tree element, and if the click fails to open the element, performs a double click instead.

This parameter is ignored for Firefox and Chrome browsers./

Return Type

None.

IMPORTANT

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.
The x-coordinate within the source object.
Default value = -9999
y Optional. A long integer value.
The y-coordinate within the source object.
Default value = -9999
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:

  • micAlt
  • micCtrl
  • micShift

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 in the run session.

This test object method is not supported on Safari browsers.

UFT supports the following scenarios:

General Note:

UFT always runs Drag and Drop steps using the mouse API, even if you defined the Replay type as Event in the Run Settings node of the Web > Advanced pane of the Options dialog box (Tools > Options > GUI Testing tab > Web > Advanced node).

Notes for Scenario A:

Notes for Scenario B and C:

Example


 

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.
The x-coordinate of the target object on whcih 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 = -9999
y Optional. A long 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 = -9999

Return Type

None

IMPORTANT

Example


 

Back to top

Expand Method

Description

Expand the tree to a specific item based on the specified path.

Syntax

object.Expand (itemPath, [XPathToOpener], [doDblClickOnOpener)

Arguments

Parameter Description
itemPath Required. A String value.

The path to the node which expands the tree item, relative to the tree item root element.

The path can be a semicolon delimited list of tree items. The values can either be one of the items in the list or an index. To specify the index of the item to select, use "#N". Index values begin with 0.

XPathToOpener Optional. A String value.

The path to the node which expands the tree item, relative to the tree item root element.

For example, if you trying to expand/collapse a node that does not work when using name path:

  1. Spy on the icon that expands or collapses the tree.
  2. Retrieve the xpath of the expander node, such as //LI[@id="apples"]/IMG[1]. Note that the tree item root XPath is //LI[@id="apples"]
  3. Use a relative xpath based for the XPath argument, based on the tree item's place in the hierarchy. For example, IMG[1]

When you are done, the test step is WebTree.Expand "node A; node B", "IMG[1]".

 


Default value = ""
doDblClickOnOpener

Optional. A string value.

Instructs UFT to open a tree element with a double click.

Possible values:

  • TRUE: automatically performs a double-click to collapse the tree element
  • FALSE: performs a single click on the tree element, and if the click fails to open the element, performs a double click instead.

This parameter is ignored for Firefox and Chrome browsers./

Return Type

None.

IMPORTANT

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. Available events include: onchange, onclick, ondblclick, onblur, onfocus, onmousedown, onmouseup, onmouseover, onmouseout, onsubmit, onreset, and onpropertychange.
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.
The mouse button used to fire the object.
Default value = micLeftBtn

Return Type

None

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 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.

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 long press 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 object. 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

IMPORTANT


 

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 starting point.
deltaY Required. A long integer value.
The distance moved on the y-axis, relative to the starting 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 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 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 on 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 in the pinch gesture.

This is the ration 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.
Default value = 1
x Optional. A long integer value.
The x-coordinate of where the pinch gesture begins. The specified coordinates are relative ot 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 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

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

IMPORTANT


 

Back to top

Select Method

Description

Select an item in the tree.

Syntax

object.Select (itemPath, [XPathToSelector], [XPathToOpener], [doDblClickOnOpener)

Arguments

Parameter Description
itemPath Required. A String value.

A semicolon delimited list of nodes in the path.

The values in the path can either be a name of an item in the list or an index. To specify the index of the item to select, use "#N". Index values begin with 0.

XPathToSelector Optional. A String value.

The path for the selected part of the tree item, relative to the expander tree item element.

If you do not need this argument, leave it is an empty value "", but still specify the XPathToOpener argument.


Default value = ""
XPathToOpener Optional. A String value.

The path for the expander part of the tree item, relative to the tree item element.

For example, if you trying to expand/collapse a node that does not work:

  1. Spy on the icon that expands or collapses the tree.
  2. Retrieve the xpath of the expander node, such as //LI[@id="apples"]/IMG[1]. Note that the tree item root XPath is //LI[@id="apples"]
  3. Use a relative xpath based for the XPath argument, based on the tree item's place in the hierarchy. For example, IMG[1]

When you are done, the test step is WebTree.Select "node A; node B", "", "IMG[1]".


Default value = ""
doDblClickOnOpener

Optional. A string value.

Instructs UFT to open a tree element with a double click.

Possible values:

  • TRUE: automatically performs a double-click to collapse the tree element
  • FALSE: performs a single click on the tree element, and if the click fails to open the element, performs a double click instead.

This parameter is ignored for Firefox and Chrome browsers./

Return Type

None.

Example


 

Back to top

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.


 

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 ot 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 in Internet Explorer or older versions of Firefox.

This method is not supported on Windows Phone.

Example


Back to top

See also: