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

Method ActivateCell Activates (double-clicks) the specified cell in the Stingray grid.
Method ActivateColumn Activates (double-clicks) the specified Column in the Stingray grid.
Method ActivateRow Activates (double-clicks) the specified Row in the Stingray grid.
Common Method CaptureBitmap Saves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method CheckProperty Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjects Returns the collection of child objects contained within the object.
Method Click Clicks an object in a Stingray grid.
Method ClickCellButton Clicks a button item in the specified cell in the Stingray grid.
Method DblClick Double-clicks an object in a Stingray grid.
Method Drag Performs the 'drag' part of a drag and drop operation.
Method DragAndDropColumn Drags a grid Column to the specified location.
Method Drop Performs the 'drop' part of a drag and drop operation.
Method GetCellData Retrieves the contents of the specified cell from the Stingray grid.
Method GetCellDisplayedData Returns the text displayed in the grid cell.
Method GetCellProperty Retrieves the property of the specified cell from the Stingray grid.
Method GetColumnName Returns the name of the currently selected Column in the Stingray grid.
Common Method GetROProperty Returns the current value of the description properties from the object in the application.
Method GetSelectedCell Returns the Row and Column of the currently selected cell.
Method GetSelectedRow Retrieves the currently selected Row from the Stingray grid.
Method GetTableData Retrieves all of the Data contained in the table and stores it in a two-dimensional array.
Method GetTextLocation Checks whether the specified text string is contained in the specified window area.
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 GetVisibleText Returns the text from the specified area.
Method MakeCellVisible Scrolls the specified cell into view if it is not visible in the Stingray grid.
Method MouseMove Moves the mouse pointer to the designated position inside the object.
Common Method RefreshObject Instructs UFT to re-identify the object in the application the next time a step refers to this object.
Method SelectCell Selects (clicks) the specified cell in the Stingray grid.
Method SelectColumn Selects (clicks) the specified Column in the Stingray grid.
Method SelectRow Selects (clicks) the specified Row in the Stingray grid.
Method SetCellData Sets the contents of a cell to the specified text in the Stingray grid.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Common Method ToString Returns a string that represents the test object.
Method Type Types the specified string in the 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

Property ColumnCount Returns the number of Columns in the Stingray grid.
Common Property Exist Checks whether the object currently exists in the open application.
Property IsColumnHidden Indicates whether the Column is hidden.
Property IsRowHidden Indicates whether the Row is hidden.
Property RowCount Returns the number of rows in the Stingray grid.

Back to top

 

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

Back to top

 

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

Back to top

 

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

Back to top

 

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.


Tip: You can enter micNoCoordinate (-9999) 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. micNoCoordinate indicates 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

Back to top

 

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

Back to top

 

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

Back to top

 

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 Required. A predefined constant or number.
The mouse button used to drag the object.

Return Type

None

Back to top

 

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

Back to top

 

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 Required. A predefined constant or number.
The mouse button that is released to drop the object.

Return Type

None

Back to top

 

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.

Back to top

 

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.

Back to top

 

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.

Back to top

 

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.

Back to top

 

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

Back to top

 

GetSelectedRow Method

Description

Retrieves the currently selected Row from the Stingray grid.

Syntax

object.GetSelectedRow

Return Type

A String value.

Back to top

 

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

Back to top

 

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.
Top Required. A Variant.
The top coordinate of the search area within the window or screen.
Right Required. A Variant.
The right coordinate of the search area within the window or screen.
Bottom Required. A Variant.
The bottom coordinate of the search area within the window or screen.

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

Default value = True

Return Type

A Boolean value.

IMPORTANT

Back to top

 

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

Back to top

 

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

Back to top

 

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

Back to top

 

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

Back to top

 

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

Back to top

 

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

Back to top

 

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.

Back to top

 

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:
Constant
Action
micCtrlDwn
Presses the Ctrl key.
micCtrlUp
Releases the Ctrl key.
micLCtrlDwn
Presses the left Ctrl key.
micLCtrlUp
Releases the left Ctrl key.
micRCtrlDwn
Presses the right Ctrl key.
micRCtrlUp
Releases the right Ctrl key.
micAltDwn
Presses the Alt key.
micAltUp
Releases the Alt key.
micLAltDwn
Presses the left Alt key.
micLAltUp
Releases the left Alt key.
micRAltDwn
Presses the right Alt key.
micRAltUp
Releases the right Alt key.
micShiftDwn
Presses the Shift key.
micShiftUp
Releases the Shift key.
micLShiftDwn
Presses the left Shift key.
micLShiftUp
Releases the left Shift key.
micRShiftDwn
Presses the right Shift key.
micRShiftUp
Releases the right Shift key.
micIns
Presses the Insert key.
micDel
Presses the Delete key.
micHome
Presses the Home key.
micEnd
Presses the End key.
micPgUp
Presses the Page Up key.
micPgDwn
Presses the Page Down key.
micUp
Presses the Up arrow key.
micDwn
Presses the Down arrow key.
micLeft
Presses the Left arrow key.
micRight
Presses the Right arrow key.
micEsc
Presses the Esc key.
micBack
Presses the Backspace key.
micReturn
Presses the Return key.
micTab
Presses the Tab key.
micBreak
Presses the Break key.
micPause
Presses the Pause key.
micPrintScr
Presses the Print Screen key.
micWinLogoDwn
Presses the Windows Logo key.
micWinLogoUp
Releases the Windows Logo key.
micLWinLogoDwn
Presses the left Windows Logo key.
micLWinLogoUp
Releases the left Windows Logo key.
micRWinLogoDwn
Presses the right Windows Logo key.
micRWinLogoUp
Releases the right Windows Logo key.
micAppKey
Presses the Application key.
micF1
Presses the F1 key.
micF2
Presses the F2 key.
micF3
Presses the F3 key.
micF4
Presses the F4 key.
micF5
Presses the F5 key.
micF6
Presses the F6 key.
micF7
Presses the F7 key.
micF8
Presses the F8 key.
micF9
Presses the F9 key.
micF10
Presses the F10 key.
micF11
Presses the F11 key.
micF12
Presses the F12 key.
micNumLockOn
Turns on the Num Lock.
micCapsLockOn
Turns on the Caps Lock.
micScrollOn
Turns on the Scroll Lock.
micNumLockOff
Turns off the Num Lock.
micCapsLockOff
Turns off the Caps Lock.
micScrollOff
Turns off the Scroll Lock.

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.

Back to top

 

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

Back to top

 

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

Back to top

 

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

Back to top

 

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

Back to top

See also: