WinTable Object
Description
A Stingray grid.
Operations
The sections below list the built-in methods and properties that you can use as operations for the WinTable object.
Note: You can also view a list and descriptions of the WinTable 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 (double-clicks) the specified cell in the Stingray grid. |
ActivateColumn | Activates (double-clicks) the specified Column in the Stingray grid. |
ActivateRow | Activates (double-clicks) the specified Row in the Stingray grid. |
CaptureBitmap | Saves a screen capture of the object as a .png or .bmp image using the specified file name. |
CheckProperty | Checks whether the actual value of the specified object property matches the specified expected 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 an object in a Stingray grid. |
ClickCellButton | Clicks a button item in the specified cell in the Stingray grid. |
DblClick | Double-clicks an object in a Stingray grid. |
Drag | Performs the 'drag' part of a drag and drop operation. |
DragAndDropColumn | Drags a grid Column to the specified location. |
Drop | Performs the 'drop' part of a drag and drop operation. |
GetCellData | Retrieves the contents of the specified cell from the Stingray grid. |
GetCellDisplayedData | Returns the text displayed in the grid cell. |
GetCellProperty | Retrieves the property of the specified cell from the Stingray grid. |
GetColumnName | Returns the name of the currently selected Column in the Stingray grid. |
GetROProperty | Returns the current value of the description property from the object in the application. |
GetSelectedCell | Returns the Row and Column of the currently selected cell. |
GetSelectedRow | Retrieves the currently selected Row from the Stingray grid. |
GetTableData | Retrieves all of the Data contained in the table and stores it in a two-dimensional array. |
GetTextLocation | Checks whether the specified text string is contained in the specified window area. |
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. |
GetVisibleText | Returns the text from the specified area. |
MakeCellVisible | Scrolls the specified cell into view if it is not visible in the Stingray grid. |
MouseMove | Moves the mouse pointer to the designated position inside the object. |
RefreshObject | Instructs OpenText Functional Testing to re-identify the object in the application the next time a step refers to this object. |
SelectCell | Selects (clicks) the specified cell in the Stingray grid. |
SelectColumn | Selects (clicks) the specified Column in the Stingray grid. |
SelectRow | Selects (clicks) the specified Row in the Stingray grid. |
SetCellData | Sets the contents of a cell to the specified text in the Stingray grid. |
SetTOProperty | Sets the value of the specified description property in the test object description. |
ToString | Returns a string that represents the test object. |
Type | Types the specified string in the object. |
WaitProperty | Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step. |
Properties
ColumnCount | Returns the number of Columns in the Stingray grid. |
Exist | Checks whether the object currently exists in the open application. |
IsColumnHidden | Indicates whether the Column is hidden. |
IsRowHidden | Indicates whether the Row is hidden. |
RowCount | Returns the number of rows in the Stingray grid. |
ActivateCell Method
Description
Activates (double-clicks) the specified cell in the Stingray grid.
Syntax
object.ActivateCell Row, Column, [BUTTON]
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The 0-based index of the row containing the cell you want to activate. The index value is recorded in the format "#N" where N is the 0-based row index. When entering the argument value manually, you can use any of the following string or number formats: "#N" or N. |
Column |
Required. A Variant. The name or 0-based index of the column containing the cell you want to activate. The column value is recorded in the format "#N" where N is the 0-based column index. When entering the argument value manually, you can use any of the following string or number formats: "ColumnName", "#N" or N. |
BUTTON |
Optional. A predefined constant or number. The mouse button to use for activating the cell. Default value = micLeftBtn |
Return Type
None
ActivateColumn Method
Description
Activates (double-clicks) the specified Column in the Stingray grid.
Syntax
object.ActivateColumn Column, [BUTTON]
Arguments
Parameter | Description |
---|---|
Column |
Required. A Variant. The name or 0-based index of the column you want to activate. The column value is recorded in the format "#N" where N is the 0-based column index. When entering the argument value manually, you can use any of the following string or number formats: "ColumnName", "#N" or N. |
BUTTON |
Optional. A predefined constant or number. The mouse button to use for activating the column. Default value = micLeftBtn |
Return Type
None
ActivateRow Method
Description
Activates (double-clicks) the specified Row in the Stingray grid.
Syntax
object.ActivateRow Row, [BUTTON]
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The 0-based index of the row you want to activate. The index value is recorded in the format "#N" where N is the 0-based row index. When entering the argument value manually, you can use any of the following string or number formats: "#N" or N. |
BUTTON |
Optional. A predefined constant or number. The mouse button to use for activating the row. Default value = micLeftBtn |
Return Type
None
Click Method
Description
Clicks an object in a Stingray grid.
Syntax
object.Click [X], [Y], [BUTTON]
Arguments
Parameter | Description |
---|---|
X |
Optional. An integer value. The x-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = -9999 |
Y |
Optional. An integer value. The y-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999 |
BUTTON |
Optional. A predefined constant or number. The mouse button used to click the object. Default value = micLeftBtn |
Return Type
None
ClickCellButton Method
Description
Clicks a button item in the specified cell in the Stingray grid.
Syntax
object.ClickCellButton Row, Column
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The 0-based index of the row containing the cell button you want to click. The index value is recorded in the format "#N" where N is the 0-based row index. When entering the argument value manually, you can use any of the following string or number formats: "#N" or N. |
Column |
Required. A Variant. The name or 0-based index of the column containing the cell button you want to click. The column value is recorded in the format "#N" where N is the 0-based column index. When entering the argument value manually, you can use any of the following string or number formats: "ColumnName", "#N" or N. |
Return Type
None
DblClick Method
Description
Double-clicks an object in a Stingray grid.
Syntax
object.DblClick X, Y, [BUTTON]
Arguments
Parameter | Description |
---|---|
X |
Required. An integer value. The x-coordinate of the double-click. Note that the specified coordinates are relative to the upper left corner of the object. |
Y |
Required. An integer value. The y-coordinate of the double-click. Note that the specified coordinates are relative to the upper left corner of the object. |
BUTTON |
Optional. A predefined constant or number. The mouse button used to double-click the object. Default value = micLeftBtn |
Return Type
None
Drag Method
Description
Performs the 'drag' part of a drag and drop operation.
Syntax
object.Drag X, Y, BUTTON
Arguments
Parameter | Description |
---|---|
X |
Required. An integer value. The x-coordinate within the window from which the object is dragged. Note that the specified coordinates are relative to the upper left corner of the object. |
Y |
Required. An integer value. The y-coordinate within the window from which the object is dragged. Note that the specified coordinates are relative to the upper left corner of the object. |
BUTTON |
Optional. A predefined constant or number. The mouse button used to drag the object. |
Return Type
None
DragAndDropColumn Method
Description
Drags a grid Column to the specified location.
Syntax
object.DragAndDropColumn SourceColumn, TargetColumn
Arguments
Parameter | Description |
---|---|
SourceColumn |
Required. A Variant. The grid column you want to drag. |
TargetColumn |
Required. A Variant. The location in which you want to drop the dragged column. |
Return Type
None
Drop Method
Description
Performs the 'drop' part of a drag and drop operation.
Syntax
object.Drop X, Y, BUTTON
Arguments
Parameter | Description |
---|---|
X |
Required. An integer value. The x-coordinate of the object onto which the object is dropped. Note that the specified coordinates are relative to the upper left corner of the object. |
Y |
Required. An integer value. The y-coordinate of the object onto which the object is dropped. Note that the specified coordinates are relative to the upper left corner of the object. |
BUTTON |
Optional. A predefined constant or number. The mouse button that is released to drop the object. |
Return Type
None
GetCellData Method
Description
Retrieves the contents of the specified cell from the Stingray grid.
Syntax
object.GetCellData (Row, Column)
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The 0-based index of the row containing the cell whose data you want to retrieve. The index value is recorded in the format "#N" where N is the 0-based row index. When entering the argument value manually, you can use any of the following string or number formats: "#N" or N. |
Column |
Required. A Variant. The name or 0-based index of the column containing the cell whose data you want to retrieve. The column value is recorded in the format "#N" where N is the 0-based column index. When entering the argument value manually, you can use any of the following string or number formats: "ColumnName", "#N" or N. |
Return Type
A String value.
IMPORTANT
This method always retrieves the full (unformatted or raw) cell data, even if the cell is formatted to display data in a certain way. For example, suppose that the cell is formatted to display two digits to the right of the decimal point, and the actual value in a cell is 2.56789. This method returns 2.56789 (even though the value is displayed as 2.57 in the cell).
To retrieve formatted (displayed) cell data, use the GetCellDisplayedData method.
GetCellDisplayedData Method
Description
Returns the text displayed in the grid cell.
Syntax
object.GetCellDisplayedData (Row, Column)
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The 0-based index of the row containing the cell whose formatted data you want to retrieve. The index value is recorded in the format "#N" where N is the 0-based row index. When entering the argument value manually, you can use any of the following string or number formats: "#N" or N. |
Column |
Required. A Variant. The name or 0-based index of the column containing the cell whose formatted data you want to retrieve. The column value is recorded in the format "#N" where N is the 0-based column index. When entering the argument value manually, you can use any of the following string or number formats: "ColumnName", "#N" or N. |
Return Type
A String value.
IMPORTANT
If the cell data in the Stingray grid is formatted, the method returns the data as it is displayed in the cell. For example, suppose that the actual value in a cell is 4.56789. If the cell is formatted to display two digits to the right of the decimal point, this method returns the displayed number (4.57) and not the actual cell value.
If the cell data is not formatted, this method returns the same value as GetCellData.
GetCellProperty Method
Description
Retrieves the property of the specified cell from the Stingray grid.
Syntax
object.GetCellProperty (Row, Column, PropertyName)
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The 0-based index of the row containing the cell whose property you want to retrieve. Enter the value in the format "#N", where N is the 0-based row index. |
Column |
Required. A Variant. The name or 0-based index of the column containing the cell whose property you want to retrieve. The column value is recorded in the format "#N", where N is the 0-based column index. When entering the argument value manually, you can use the following string formats: "ColumnName", N, or "#N". |
PropertyName |
Required. A String value. The name of the property that you want to retrieve. Possible Values: Hidden--The cell's hidden state. TextColor--The cell's color setting. FontID--The unique identifier for the font face name (integer). FontSize--The size of the font in the cell. IsBold--Indicates whether the font weight is bold. IsItalic--Indicates whether the font weight is italic. IsUnderline--The underline style setting. IsStrikeout--The strikeout style setting. |
Return Type
A Variant.
GetColumnName Method
Description
Returns the name of the currently selected Column in the Stingray grid.
Syntax
object.GetColumnName (ColumnIndex)
Arguments
Parameter | Description |
---|---|
ColumnIndex |
Required. A Variant. The 0-based index of the column whose name you want to retrieve. The column value is recorded in the format "#N" where N is the 0-based column index. When entering the argument value manually, you can use any of the following string or number formats: "ColumnName", "#N" or N. |
Return Type
A String value.
GetSelectedCell Method
Description
Returns the Row and Column of the currently selected cell.
Syntax
object.GetSelectedCell Row, Column
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The output value of the currently selected row. |
Column |
Required. A Variant. The output value of the currently selected column. |
Return Type
None
Example
'The following example uses the GetSelectedCell method to select the cell 'below the currently selected cell in a Stingray grid. Window("GRIDAPP Windows Application").Window("GridAp1").WinTable("StingrayGrid").GetSelectedCell row, col row = Int(Right(row, Len(row) - 1)) row = row + 1 Window("GRIDAPP Windows Application").Window("GridAp1").WinTable("StingrayGrid").SelectCell row, col
GetSelectedRow Method
Description
Retrieves the currently selected Row from the Stingray grid.
Syntax
object.GetSelectedRow
Return Type
A String value.
GetTableData Method
Description
Retrieves all of the Data contained in the table and stores it in a two-dimensional array.
Syntax
object.GetTableData
Return Type
A Variant.
Example
'The following example uses the GetTableData method to aggregate (provide a sum total of) 'data for all of the cells in a Stingray grid. tableArr = Window("GRIDAPP Windows Application").Window("GridAp1").WinTable("StingrayGrid").GetTableData Sum = 0 For Each cell In tableArr Sum = Sum + cell Next
GetTextLocation Method
Description
Checks whether the specified text string is contained in the specified window area.
Syntax
object.GetTextLocation (TextToFind, Left, Top, Right, Bottom, [MatchWholeWordOnly])
Arguments
Parameter | Description |
---|---|
TextToFind |
Required. A String value. The text string you want to locate. |
Left |
Required. A Variant. The left coordinate of the search area within the window or screen, as a long integer. |
Top |
Required. A Variant. The top coordinate of the search area within the window or screen, as a long integer. |
Right |
Required. A Variant. The right coordinate of the search area within the window or screen, as a long integer. |
Bottom |
Required. A Variant. The bottom coordinate of the search area within the window or screen, as a long integer. Note: Set the Left, Top, Right, and Bottom coordinates to -1 to search for the text string within the object's entire window. |
MatchWholeWordOnly |
Optional. A Boolean value. If True, the method searches for occurrences that are whole words only and not part of a larger word. If False, the method does not restrict the results to occurrences that are whole words only. Default value = True |
Return Type
A Boolean value.
IMPORTANT
- The text to capture must be visible in the application window when the step runs.
- This method returns True only if the TextToFind argument value is found within a single line in the specified area. The text search restarts on each line of text.
- If the TextToFind argument value includes a space, then this method searches for that text as whole words, regardless of the value set in the MatchWholeWords argument. For example, if you search for "a b" and the text "bla bla" exists, the method will still return False. However, if the MatchWholeWords argument is set to False, then a search for "la" in an area where "bla bla" exists, would return True.
- If the text is found (return value = True) and if the Left, Top, Right, and Bottom arguments are supplied as variables, then the method also returns the exact coordinates of the specified text to the supplied arguments (the returned coordinates overwrite the supplied ones).
- The results of this method may be different depending on the settings selected in the Text Recognition pane of the Options dialog box (Tools menu > Options item > GUI Testing tab > Text Recognition pane).
- The results of this method may be different in different run sessions depending on the operating system version you are using, service packs you have installed, other installed toolkits, or the APIs used in your application. Therefore, when possible, it is highly recommended to use the GetROProperty method to retrieve the value of the text (or equivalent) property from an object in your application instead of using the GetTextLocation method.
- By default, when OpenText Functional Testing captures text for a text/text area checkpoint or output value step using the GetText, GetTextLocation, or GetVisibleText methods, it tries to retrieve the text directly from the object using a Windows API-based mechanism. If OpenText Functional Testing cannot capture the text this way (for example, because the text is part of a picture), it tries to capture the text using an OCR (optical character recognition) mechanism. For details about changing this behavior, see the Can QuickTest Professional Text Recognition behavior be modified Knowledgebase article (number KM202721).
GetVisibleText Method
Description
Returns the text from the specified area.
Syntax
object.GetVisibleText ([Left], [Top], [Right], [Bottom])
Arguments
Parameter | Description |
---|---|
Left |
Optional. A long integer value. The left coordinate of the search area within the object's window. Default value = -1 |
Top |
Optional. A long integer value. The top coordinate of the search area the object's window. Default value = -1 |
Right |
Optional. A long integer value. The right coordinate of the search area within the object's window. Default value = -1 |
Bottom |
Optional. A long integer value. The bottom coordinate of the search area a within the object's window. Note: If the Left, Top, Right, and Bottom arguments are not specified, the method returns all of the text within the visible part of the specified object. Default value = -1 |
Return Type
A String value.
IMPORTANT
- The text to capture must be visible in the application window when the step runs.
- The area is defined by pairs of coordinates that designate two diagonally opposite corners of a rectangle.
- The results of this method may be different depending on the settings selected in the Text Recognition pane of the Options dialog box (Tools menu > Options item > GUI Testing tab > Text Recognition node).
- The results of this method may be different in different run sessions depending on the operating system version you are using, service packs you have installed, other installed toolkits, or the APIs used in your application. Therefore, when possible, it is highly recommended to use the GetROProperty method to retrieve the value of the text (or equivalent) property from an object in your application instead of using the GetVisibleText method.
- By default, when OpenText Functional Testing captures text for a text/text area checkpoint or output value step using the GetText, GetTextLocation, or GetVisibleText methods, it tries to retrieve the text directly from the object using a Windows API-based mechanism. If OpenText Functional Testing cannot capture the text this way (for example, because the text is part of a picture), it tries to capture the text using an OCR (optical character recognition) mechanism. For details about changing this behavior, see the Can QuickTest Professional Text Recognition behavior be modified Knowledgebase article (number KM202721).
MakeCellVisible Method
Description
Scrolls the specified cell into view if it is not visible in the Stingray grid.
Syntax
object.MakeCellVisible Row, Column
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The 0-based index of the row containing the cell you want to make visible. The index value is recorded in the format "#N" where N is the 0-based row index. When entering the argument value manually, you can use any of the following string or number formats: "#N" or N. |
Column |
Required. A Variant. The name or 0-based index of the column containing the cell you want to make visible. The column value is recorded in the format "#N" where N is the 0-based column index. When entering the argument value manually, you can use any of the following string or number formats: "ColumnName", "#N" or N. |
Return Type
None
MouseMove Method
Description
Moves the mouse pointer to the designated position inside the object.
Syntax
object.MouseMove X, Y
Arguments
Parameter | Description |
---|---|
X |
Required. An integer value. The x-coordinate of the mouse pointer, relative to the upper left corner of the object. |
Y |
Required. An integer value. The y-coordinate of the mouse pointer, relative to the upper left corner of the object. |
Return Type
None
SelectCell Method
Description
Selects (clicks) the specified cell in the Stingray grid.
Syntax
object.SelectCell Row, Column, [BUTTON]
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The 0-based index of the row containing the cell you want to select. The index value is recorded in the format "#N" where N is the 0-based row index. When entering the argument value manually, you can use any of the following string or number formats: "#N" or N. |
Column |
Required. A Variant. The name or 0-based index of the column containing the cell you want to select. The column value is recorded in the format "#N" where N is the 0-based column index. When entering the argument value manually, you can use any of the following string or number formats: "#N" or N. |
BUTTON |
Optional. A predefined constant or number. The mouse button to use for selecting the cell. Default value = micLeftBtn |
Return Type
None
SelectColumn Method
Description
Selects (clicks) the specified Column in the Stingray grid.
Syntax
object.SelectColumn Column, [BUTTON]
Arguments
Parameter | Description |
---|---|
Column |
Required. A Variant. The name or 0-based index of the column you want to select. The column value is recorded in the format "#N" where N is the 0-based column index. When entering the argument value manually, you can use any of the following string or number formats: "#N" or N. |
BUTTON |
Optional. A predefined constant or number. The mouse button to use for selecting the column. Default value = micLeftBtn |
Return Type
None
SelectRow Method
Description
Selects (clicks) the specified Row in the Stingray grid.
Syntax
object.SelectRow Row, [BUTTON]
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The 0-based index of the row you want to select. The index value is recorded in the format "#N" where N is the 0-based row index. When entering the argument value manually, you can use any of the following string or number formats: "#N" or N. |
BUTTON |
Optional. A predefined constant or number. The mouse button to use for selecting the row. Default value = micLeftBtn |
Return Type
None
SetCellData Method
Description
Sets the contents of a cell to the specified text in the Stingray grid.
Syntax
object.SetCellData Row, Column, Data
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The 0-based index of the row containing the cell data you want to set. The index value is recorded in the format "#N" where N is the 0-based row index. When entering the argument value manually, you can use any of the following string or number formats: "#N" or N. |
Column |
Required. A Variant. The name or 0-based index of the column containing the cell whose data you want to set. The column value is recorded in the format "#N" where N is the 0-based column index. When entering the argument value manually, you can use any of the following string or number formats: "ColumnName", "#N" or N. |
Data |
Required. A String value. The contents to be entered into the specified cell. |
Return Type
None
IMPORTANT
This method is supported only while recording on check boxes in a Stingray grid. However, you can set data for any cell control by manually adding a SetCellData statement in the Keyword View or in the Editor.
Type Method
Description
Types the specified string in the object.
Syntax
object.Type KeyboardInput
Arguments
Parameter | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
KeyboardInput |
Required. A String value. The text string and/or constants representing non-alphanumeric keys. The following constants are available:
|
Return Type
None
IMPORTANT
Although the Type method is supported for most objects, if you enter a Type statement for an object in which a user cannot enter text, the method has no visual effect.
ColumnCount Property
Description
Returns the number of Columns in the Stingray grid.
Syntax
object.ColumnCount
Value Type
An integer value.
Property type
Read-only property
IsColumnHidden Property
Description
Indicates whether the Column is hidden.
Syntax
object.IsColumnHidden (Column)
Arguments
Parameter | Description |
---|---|
Column |
Required. A Variant. The name or 0-based index of the column you want to check. The column value is recorded in the format "#N", where N is the 0-based column index. When entering the argument value manually, you can use the following string formats: "ColumnName" or "#N". |
Value Type
A Boolean value.
Property type
Read-only property
IsRowHidden Property
Description
Indicates whether the Row is hidden.
Syntax
object.IsRowHidden (Row)
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The 0-based index of the row you want to check. The index value is recorded in the format "#N" where N is the 0-based row index. When entering the argument value manually, you can use any of the following string or number formats: "#N" or N. |
Value Type
A Boolean value.
Property type
Read-only property
RowCount Property
Description
Returns the number of rows in the Stingray grid.
Syntax
object.RowCount
Value Type
A long integer value.
Property type
Read-only property
See also: