Share this page
XJSTable Object
Description
A table/grid control in an EXT-JS application.
IMPORTANT
The XJSTable 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 XJSTable object.
Note: You can also view a list and descriptions of the XJSTable 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
 ActivateCell | Activates a cell for editing. |
| CallAction | Performs an action on an specified cell (if the action exists). |
 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. |
| ChildItem | Returns a test object from the cell by type and index. |
| 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. |
| ClickCell | Clicks the cell which contains clickable content. |
| ClickHeader | Clicks the column header |
| CollapseGroup | Collapses a group of rows in the table. |
| 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. |
| ExpandGroup | Expands a group of rows in the table. |
| ExtendDeselect | Selects several items or range |
| ExtendSelect | Selects several items or a range of items. |
| FireEvent | Triggers an event. |
| GetCellData | Returns the text contained in the specified cell. |
| GetCellProperty | Retrieves the selected cell's property. |
| 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. (Mobile and Web add-ins only) |
| MiddleClick | Middle-clicks the object. |
| 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. |
| Scroll | Scrolls the table until the selected cell is visible. |
| SelectCell | Selects a cell. |
| SelectRow | Selects a row in the table. |
| SetCellData | Set the value of a table cell. |
| SetTOProperty | Sets the value of the specified description property in the test object description. |
| ShowColumnMenu | Displays a column's menu |
| Sort | Sorts the column. |
| Submit | Submits a form. |
| Swipe | Swipes the object. (Mobile and Web add-ins only) |
| 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. |
ActivateCell Method
Description
Activates a cell for editing.
Syntax
object.ActivateCell Row, Column
Arguments
| Parameter | Description |
|---|---|
| Row |
Required. A Variant. The 0-based index of the row you want to activate. To specify a row number, use the number, or the format "#N", where N is the numeric value. |
| Column |
Required. A Variant. The location of the column within the grid. Use the column header name or the column index (0-based). To specify a column number, use the number, or the format "#N", where N is the numeric value. |
Return Type
None
IMPORTANT
- This method is the equivalent of a double-click on the cell.
- The run results for this method do not include the parameter values used during the run session.
Example
Activate a Table Cell for Editing (VBScript)
'The following example activates a cell in an XJSTable object.
Browser("Ext JS Kitchen Sink -").Page("Ext JS Kitchen Sink -_5").XJSTable("XJSTable").ActivateCell 1,1
CallAction Method
Description
Performs an action on an specified cell (if the action exists).
Syntax
object.CallAction Row, Action
Arguments
| Parameter | Description |
|---|---|
| Row |
Required. A Variant. The 0-based index of the row you want to activate. To specify a row number, use the number, or the format "#N", where N is the numeric value. |
| Action |
Required. A Variant. The location of the column within the grid. Use the column header name or the column index (0-based). To specify a column number, use the number, or the format "#N", where N is the numeric value. |
Return Type
None
IMPORTANT
- This method is used to perform actions when a table cell contains a clickable image that enables you to perform another action, such as "delete row" or "send mail".
- This method is recorded only if a cell has an action that can be performed.
Example
Perform a Table Cell Action (VBScript)
'The following example calls an action for a cell in an XJSTable.
Browser("Ext JS Kitchen Sink -").Page("Ext JS Kitchen Sink -_5").XJSTable("XJSTable").CallAction 2,"Buy stock"
ChildItem Method
Description
Returns a test object from the cell by type and index.
Syntax
object.ChildItem (Row, Column, MicClass, Index)
Arguments
| Parameter | Description |
|---|---|
| Row |
Required. An integer value. |
| Column |
Required. An integer value. |
| MicClass |
Required. A String value. |
| Index |
Required. An integer value. |
Return Type
An 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 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
IMPORTANT
- UFT One does not record the Click method for right- or middle-clicks. Instead, UFT One records 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 Help Center.
- For some Mozilla Firefox objects, this method is recorded only if a handler is present.
Example
Click a Table Object (VBScript)
'The following example clicks an XJSTable object (not a cell inside).
Browser("Ext JS Kitchen Sink -").Page("Ext JS Kitchen Sink -_5").XJSTable("XJSTable").Click 75,75
ClickCell Method
Description
Clicks the cell which contains clickable content.
Syntax
object.ClickCell Row, Column, [x], [y], [BUTTON]
Arguments
| Parameter | Description |
|---|---|
| Row |
Required. A Variant. The 0-based index of the row you want to activate. To specify a row number, use the number, or the format "#N", where N is the numeric value. |
| Column |
Required. A Variant. The location of the column within the grid. Use the column header name or the column index (0-based). To specify a column number, use the number, or the format "#N", where N is the numeric value. |
| x |
Optional. A Any Value. The x-coordinate of the click. |
| y |
Optional. A Any Value. The y-coordinate of the click. |
| BUTTON |
Optional. An integer value. The mouse button used to click the object. Default value = 0 |
Return Type
None
IMPORTANT
This method is used to click a table cell when the cell contains non-editable content, such as links, buttons, and images.
Example
Click an Individual Table Cell (VBScript)
'The following example clicks a cell inside an XJSTable object.
Browser("Ext JS Kitchen Sink -").Page("Ext JS Kitchen Sink -_5").XJSTable("XJSTable").ClickCell 1,1
ClickHeader Method
Description
Clicks the column header
Syntax
object.ClickHeader Column, [x], [y], [BUTTON]
Arguments
| Parameter | Description |
|---|---|
| Column |
Required. A Variant. The location of the column within the grid. Use the column header name or the column index (0-based). To specify a column number, use the number, or the format "#N", where N is the numeric value. |
| x |
Optional. A Any Value. The x-coordinate of the click. |
| y |
Optional. A Any Value. The y-coordinate of the click. |
| BUTTON |
Optional. An integer value. T'he mouse button used to make the click. Default value = 0 |
Return Type
None
CollapseGroup Method
Description
Collapses a group of rows in the table.
Syntax
object.CollapseGroup Group
Arguments
| Parameter | Description |
|---|---|
| Group |
Required. A Variant. The group name or index. To specify a group number, use the number, or the format "#N", where N is the numeric value. |
Return Type
None
IMPORTANT
The run results for this method do not include the parameter values used during the run session.
Example
Collapse a Group of Rows in the Table (VBScript)
'The following example collapses an expanded group of rows in an XJSTable.
Browser("Ext JS Kitchen Sink -").Page("Ext JS Kitchen Sink -_7").XJSTable("XJSTable").CollapseGroup "Cuisine: American (9 Items)"
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 Digital Lab 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
IMPORTANT
Drag and Drop operations are performed as a coupled step. Inserting one operation without the other causes an error in the run session.
The test object method is not supported on Safari browsers.
UFT One 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 object), 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:
UFT One always runs Drag and Drop steps using the mouse API, even if you defined the Replay type as Event in the Run Settings section 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 an object on another object or in another frame). You can, however, insert these type 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 UFT One supports scrolling when the Drag and Drop test object are both located in the same frame. UFT One drags the Drag object to 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 UFT One 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, UFT One 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 Scenario 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 step are located outside of the visible frame area (for example, because you application changed), then the step may not run accurately. To solve this, fix the specified coordinates, as needed. The test object can be dragged only within the visible area of the frame object. Dragging the object to the edge of a window or frame does not cause the area to scroll (as it does in Scenario A).
Example
Drag a Panel Object (VBScript)
'The following example drags an XJSPanel object.
Browser("Browser_3").Page("Ext JS - Sencha Docs_3").Frame("Frame").XJSPanel("XJSPanel").Drag 75,75
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 details on Drag and Drop operations, see Drag Method.
- This test object method is not supported on Safari browsers.
Example
Drop a Dragged Panel Object (VBScript)
'The following example drops a dragged XJSPanel object.
Browser("Browser_3").Page("Ext JS - Sencha Docs_3").Frame("Frame").XJSPanel("XJSPanel").Drop 90,100
ExpandGroup Method
Description
Expands a group of rows in the table.
Syntax
object.ExpandGroup Group
Arguments
| Parameter | Description |
|---|---|
| Group |
Required. A Variant. The group name or index. To specify a group number, use the number, or the format "#N", where N is the numeric value. |
Return Type
None
Example
Expand a Group of Rows in the Table (VBScript)
'The following example expands a group of rows in an XJSTable object.
Browser("Ext JS Kitchen Sink -").Page("Ext JS Kitchen Sink -_7").XJSTable("XJSTable").ExpandGroup "Cuisine: American (9 Items)"
ExtendDeselect Method
Description
Selects several items or range
Syntax
object.ExtendDeselect Row, Column
Arguments
| Parameter | Description |
|---|---|
| Row |
Required. A Variant. The 0-based index of the row you want to clear. To specify a row number, use the number, or the format "#N", where N is the numeric value. |
| Column |
Required. A Variant. The location of the column within the grid. Use the column header name or the column index (0-based). To specify a column number, use the number, or the format "#N", where N is the numeric value. |
Return Type
None
ExtendSelect Method
Description
Selects several items or a range of items.
Syntax
object.ExtendSelect Row, Column, [Range]
Arguments
| Parameter | Description |
|---|---|
| Row |
Required. A Variant. The 0-based index of the row you want to activate. To specify a row number, use the number, or the format "#N", where N is the numeric value. |
| Column |
Required. A Variant. The location of the column within the grid. Use the column header name or the column index (0-based). To specify a column number, use the number, or the format "#N", where N is the numeric value. |
| Range |
Optional. A Boolean value. Indicates whether the cells between the specified cells (in the Row and Column arguments) are selected as a range. Default value = False |
Return Type
None
Example
Select an Additional Cell in the Table (VBScript)
'The following example selects an additional cell (with other cells already selected) in
'an XJSTable object.
Browser("Ext JS Kitchen Sink -").Page("Ext JS Kitchen Sink -_7").XJSTable("XJSTable").ExtendSelect 1,1
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, 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
Fire the OnClick Event on a Button Object (VBScript)
'The following example fires the onclick event on an XJSButton object.
Browser("Ext JS Kitchen Sink -").Page("Ext JS Kitchen Sink -").XJSButton("XJSButton").FireEvent "onclick"
GetCellData Method
Description
Returns the text contained in the specified cell.
Syntax
object.GetCellData (Row, Column)
Arguments
| Parameter | Description |
|---|---|
| Row |
Required. A Variant. The 0-based index of the row you want to activate. To specify a row number, use the number, or the format "#N", where N is the numeric value. |
| Column |
Required. A Variant. To specify a column number, use the number, or the format "#N", where N is the numeric value. |
Return Type
A String value.
Example
Retrieve the Data from a Table Cell (VBScript)
'The following example retrieves the data inside the selected cell of an XJSTable object.
Browser("Ext JS Kitchen Sink -").Page("Ext JS Kitchen Sink -_6").XJSTable("XJSTable").GetCellData 1,1
GetCellProperty Method
Description
Retrieves the selected cell's property.
Syntax
object.GetCellProperty (Row, Column, Property)
Arguments
| Parameter | Description |
|---|---|
| Row |
Required. A Variant. The 0-based index of the row you want to activate. To specify a row number, use the number, or the format "#N", where N is the numeric value. |
| Column |
Required. A Variant. The location of the column within the grid. Use the column header name or the column index (0-based). To specify a column number, use the number, or the format "#N", where N is the numeric value. |
| Property |
Required. A String value. The property to retrieve from the selected cell. Possible values:
|
Return Type
A Variant.
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 Digital Lab 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 Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
Example
Perform a LongPress on a Table (VBScript)
'The following example performs a LongPress on an XJSTable object.
Device("Device").App("Mobile Web_2").MobileWebView("Web View").Page("Checkbox and radio inputs").XJSTable("XJSTable").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. 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. Default value = 0 |
Return Type
None
IMPORTANT
- Ift 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 topic on the Custom Web Event Recording Configuration in the Add-ins section of the UFT One 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), UFT One fires onmousedown, onfocus, 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
Middle Click a Button Object (VBScript)
'The following example performs a middle mouse button click on an XJSButton object.
Browser("Ext JS Kitchen Sink -").Page("Ext JS Kitchen Sink -").XJSButton("XJSButton").MiddleClick 75,75
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 perform 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 Digital 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 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 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 Digital 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 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 topic on the Custom Web Event Recording Configuration in the Add-ins section of the UFT One Help Center.
- When Event Replay is selected as the Replay type in the Web > Advanced pane of the Options dialog box (Tools > Options > GUI Testing tab > Web > Advanced node), UFT One 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.
Example
Right-Click a Button Object (VBScript)
'The following example performs a right-click on an XJSButton object.
Browser("Ext JS Kitchen Sink -").Page("Ext JS Kitchen Sink -").XJSButton("XJSButton").RightClick 75,75
Scroll Method
Description
Scrolls the table until the selected cell is visible.
Syntax
object.Scroll Row, [Column]
Arguments
| Parameter | Description |
|---|---|
| Row |
Required. A Variant. The 0-based index of the row you want to activate. To specify a row number, use the number, or the format "#N", where N is the numeric value. |
| Column |
Optional. A Variant. The location of the column within the grid. Use the column header name or the column index (0-based). To specify a column number, use the number, or the format "#N", where N is the numeric value. |
Return Type
None
SelectCell Method
Description
Selects a cell.
Syntax
object.SelectCell Row, Column
Arguments
| Parameter | Description |
|---|---|
| Row |
Required. A Variant. The 0-based index of the row you want to activate. To specify a row number, use the number, or the format "#N", where N is the numeric value. |
| Column |
Required. A Variant. The location of the column within the grid. Use the column header name or the column index (0-based). To specify a column number, use the number, or the format "#N", where N is the numeric value. |
Return Type
None
IMPORTANT
- This method is the equivalent of clicking on a cell in the table.
- The run results for this method do not include the parameter values used during the run session.
Example
Select a Cell in the Table (VBScript)
'The following example selects a cell from an XJSTable object.
Browser("Ext JS Kitchen Sink -").Page("Ext JS Kitchen Sink -_5").XJSTable("XJSTable").SelectCell 2,"Company"
SelectRow Method
Description
Selects a row in the table.
Syntax
object.SelectRow Row
Arguments
| Parameter | Description |
|---|---|
| Row |
Required. A Variant. The 0-based index of the row you want to activate. To specify a row number, use the number, or the format "#N", where N is the numeric value. |
Return Type
None
Example
Select a Row in the Table (VBScript)
'The following example selects a row in an XJSTable object.
Browser("Ext JS Kitchen Sink -").Page("Ext JS Kitchen Sink -_5").XJSTable("XJSTable").SelectRow 2
SetCellData Method
Description
Set the value of a table cell.
Syntax
object.SetCellData Row, Column, Data
Arguments
| Parameter | Description |
|---|---|
| Row |
Required. A Variant. The 0-based index of the row you want to activate. To specify a row number, use the number, or the format "#N", where N is the numeric value. |
| Column |
Required. A Variant. The location of the column within the grid. Use the column header name or the column index (0-based). To specify a column number, use the number, or the format "#N", where N is the numeric value. |
| Data |
Required. A Variant. For most cells, the text to enter into the cell. If a table cell contains a checkbox object, then the value must be "ON" or "OFF". |
Return Type
None
IMPORTANT
- If a table cell contains another control which enables you set the value of the cell, UFT One records only the final result using this method.
- If a table cell contains a checkbox, you must set the Data parameter value as "On" or "Off".
Example
Set the Value of a Table Cell (VBScript)
'The following example sets the value of a cell in an XJSTable object.
Browser("Ext JS Kitchen Sink -").Page("Ext JS Kitchen Sink -_6").XJSTable("XJSTable").SetCellData 0,"Indoor?","OFF"
ShowColumnMenu Method
Description
Displays a column's menu
Syntax
object.ShowColumnMenu Column
Arguments
| Parameter | Description |
|---|---|
| Column |
Required. A Variant. The location of the column within the grid. Use the column header name or the column index (0-based). To specify a column number, use the number, or the format "#N", where N is the numeric value. |
Return Type
None
IMPORTANT
If you need to perform an action on the column's menu, use this method to show the method before performing the action.
Example
Show a Table Column's Menu (VBScript)
'The following example displays the menu for a column in an XJSTable object.
Browser("Ext JS Kitchen Sink -").Page("Ext JS Kitchen Sink -_6").XJSTable("XJSTable").ShowColumnMenu "Type"
Sort Method
Description
Sorts the column.
Syntax
object.Sort Column, [direction]
Arguments
| Parameter | Description |
|---|---|
| Column |
Required. A Variant. The location of the column within the grid. Use the column header name or the column index (0-based). To specify a column number, use the number, or the format "#N", where N is the numeric value. |
| direction |
Optional. A String value. The direction of the sort. You can enter the value as any of the following: "ASCENDING", "DESCENDING", "ASCEND", "A", "DESC", or "D". |
Return Type
None
Example
Sort a Table Column (VBScript)
'The following example sorts a column in an XJSTable object in ascending order.
Browser("Ext JS Kitchen Sink -").Page("Ext JS Kitchen Sink -_8").XJSTable("XJSTable").Sort "Value","ASCENDING"
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. (Mobile and Web add-ins only)
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 Digital 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 for Windows Phone.
Example
Swipe a Table Object (VBScript)
'The following example performs a Swipe gesture on an XJSTable object.
Device("Device").App("Mobile Web_2").MobileWebView("Web View").Page("Checkbox and radio inputs").XJSTable("XJSTable").Swipe moveDown,200,1,75,75
See also:
