WebTree Object

Description

A tree control in a Web site or application

IMPORTANT

There may be test performance issues with this object.

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 CaptureBitmapSaves a screen capture of the object as a .png or .bmp image, depending on the specified file extension.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the specified object property achieves the specified 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 CollapseCollapse the tree to a specific item based on the specified path.
Method DoubleClickClicks on the object twice.
Method DragPerforms the 'drag' part of a drag and drop operation.
Method DropPerforms the 'drop' part of a drag and drop operation.
Method ExpandExpand the tree to a specific item based on the specified path.
Method FireEventTriggers an event.
Common Method GetROPropertyReturns the current value of the specified 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 HoverTapWhen hover is supported, places the pointer on the object. Otherwise, taps the object.
Method LongPressPresses and holds the object.
Method MiddleClickMiddle-clicks the object.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Method PanPerform a pan gesture.
Method PinchPerform a pinch gesture.
Common Method RefreshObjectInstructs OpenText Functional Testing to re-identify the object in the application the next time a step refers to this object.
Method RightClickRight-clicks the object.
Method SelectSelect an item in the tree.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Method SubmitSubmits a form.
Method SwipeSwipes the object.
Common Method ToStringReturns a string that represents the current 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. 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

  • OpenText Functional Testing does not record the Click method for right- or middle-clicks. Instead, OpenText Functional Testing records the RightClick and MiddleClick methods.

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

ParameterDescription
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 OpenText Functional Testing 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

  • This test object method may be recorded incorrectly as a .Select method. If this happens, you need to manually change the method to the Collapse method after recording.
  • There may be a slight delay when using this step due to the animation of the collapse/expand operation. You should add a Wait statement after Collapse method steps to wait for this animation.

Example

Back to top

 

DoubleClick Method

Description

Clicks on the object twice.

Syntax

object.DoubleClick ([interval], [x], [y])

Arguments

ParameterDescription
interval Optional. A double floating value.
The number of seconds between the two clicks. The default value is 0.2 seconds.
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

  • This method is supported as long as the Web site being tested is run on a mobile device on OpenText Functional Testing Lab, and the test object implements this gesture. 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.

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

OpenText Functional Testing supports the following scenarios:

  • Scenario A: One object is dragged onto another object. For example, you can drag a WebButton from one frame object (source object) to another object (target objects), or drag a WebElement (source object) onto a Link object (target object) in the same frame.
  • Scenario B: An object is moved from one location in a frame to another location in the same frame. In this case, the test object used for the Drag step is the same as the test object used for the Drop step.
  • Scenario C: An item within an object is moved to another location within that object (also known as drag and pan). For example, in a map application, you can relocate an image relative to itself or drag a Slider object.

General Note:

OpenText Functional Testing 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:

  • When recording: You cannot record cross-object or cross-frame types of drag and drop operations (operations in which you try to drop and object on another object or in another frame). You can, however, insert these types of Drop steps manually. Note that it may be helpful to record a Drag and Drop operation on the object in order to determine valid coordinates for the Drag operation step. You need to delete the recorded Drop step, though, and manually add a new Drop step for the target object instead.
  • When running. If the application being tested supports scrolling, then OpenText Functional Testing supports scrolling when the Drag and Drop test objects are both located in the same frame. OpenText Functional Testing drags the Drag object ot the edge of the frame, waits for the Drop object to appear, and drops the Drag object onto the Drop object. If the application being tested does not support scrolling, then OpenText Functional Testing displays an error message when it reaches a step that requires scrolling.
  • When running. If you want to drag a test object from one frame to another, OpenText Functional Testing tries to make both the Drag and Drop objects visible in their frames prior to performing the Drag and Drop operation. If the two objects cannot be viewed simultaneously (for example, because the browser window is too small), the step fails.

Notes for Scenario B and C:

  • If the screen resolution during a run session is not the same as the screen resolution during the recording session, then the size of the frame may be different during the run session as compared to the recording session. In this case, the target location coordinates may be different during the run session and this may cause the test steps to fail.
  • During a run session, if the coordinates of a Drop

Example

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. A long 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 = -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

  • Drag and Drop operations are performed as a coupled step. Inserting one operation without the other causes an error to occur. For more details on Drag and Drop operations, see Drag Method.
  • This test object method is not supported on Safari browsers.

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

ParameterDescription
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 OpenText Functional Testing 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

  • This test object method may be recorded incorrectly as a .Select method. If this happens, you need to manually change the method to the Expand method after recording.
  • There may be a slight delay when using this step due to the animation of the collapse/expand operation. You should add a Wait statement after Collapse method steps to wait for this animation.

Example

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

ParameterDescription
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 OpenText Functional Testing Lab 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

ParameterDescription
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 OpenText Functional Testing Lab 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

ParameterDescription
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

  • If OpenText Functional Testing 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 OpenText Functional Testing 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 topic on the Custom Web Event Recording Configuration in the Add-ins section of the OpenText Functional Testing Help Center.
  • 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), OpenText Functional Testing 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.

Back to top

 

Pan Method

Description

Perform a pan gesture.

Syntax

object.Pan (deltaX, deltaY, [duration], [startX], [startY])

Arguments

ParameterDescription
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 OpenText Functional Testing Lab, 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

ParameterDescription
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 OpenText Functional Testing Lab, 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

ParameterDescription
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

  • If OpenText Functional Testing 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 OpenText Functional Testing version. In this case, you can enable recording of this method by resetting the Web Event Recording Configuration to a preconfigured level. For details, see the topic on the Custom Web Event Recording Configuration in the Add-ins section of the OpenText Functional Testing Help Center.
  • 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), OpenText Functional Testing fires onmousedown, focus, 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.

Back to top

 

Select Method

Description

Select an item in the tree.

Syntax

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

Arguments

ParameterDescription
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 OpenText Functional Testing 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

ParameterDescription
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 OpenText Functional Testing Lab 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: