SwfTable Object

Description

A grid control based on the .NET Windows Forms library.

IMPORTANT

  • The following grid controls are supported:
  • Microsoft Data Grid
  • Infragistics UltraWinGrid
  • ComponentOne C1FlexGrid
  • ComponentOne C1TrueDBGrid
  • DevExpress Data Grid (UFT One 15.0.2 and later)
  • DevExpress Pivot Grid (UFT One 15.0.2 and later)
  • DevExpress Vertical Grid (UFT One 15.0.2 and later)

For a list of supported grid control versions, see the Unified Functional Testing Product Availability Matrix.

  • UFT One recognizes .NET property grid controls as SwfPropertyGrid test objects (and not SwfTable objects).
  • When recording a drop-down window calendar in a ComponentOne C1TrueDBGrid, an additional SetDate step is recorded, and the run session fails. Remove the step before running the action.

Operations

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

Note: You can also view a list and descriptions of the SwfTable 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

In the table below, methods marked with an asterisk (*) are supported in UFT One versions 15.0.2 and later.

Method ActivateCell Double-clicks the specified cell in a grid.
Method ActivateColumn Double-clicks the specified column header in a grid.
Method ActivateRow Double-clicks the specified row header in a grid.
Method AddCellToSelection *

Adds the specified cell to the existing selection.

Method AddRow Adds a new row to the table band using the Add button for the corresponding band.
Method AddRowToSelection *

Adds the specified row to the existing selection.

Method Back Navigates back to the parent table.
Common Method CaptureBitmap Saves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method Check Checks whether the actual value of an item matches the expected value.
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 ClearGrouping *

Clears the existing column grouping.

Method ClearSelection *

Clears the existing selection in the grid.

Method Click Clicks an object.
Method CollapseRow Collapses the specified row.
Method CollapseAllGroups *

Collapses all group rows.

Method CollapseAllRows *

Collapses all rows.

Method DblClick Double-clicks an object
Method DeselectCell *

Deselects the specified cell.

Method DeselectRow *

Deselects the specified row.

Method Drag Performs the 'drag' part of a drag-and-drop operation.
Method Drop Performs the 'drop' part of a drag-and-drop operation.
Method ExpandAllGroups *

Expands all group rows.

Method ExpandAllRows *

Expands all rows.

Method ExpandRow Expands the specified row.
Method FireEvent Simulates an event on a .NET object.
Common Method GetAllROProperties

Returns the collection of properties and current values from the object in the application.

Method GetCellData Retrieves the contents of the specified cell in a grid.
Method GetCellProperty Returns the value of a grid cell property.
Method GetChildRowsCount * Returns the number of child rows of the specified row in the grid.
Method GetChildRowsPaths * Returns the paths of the child rows of the specified row in the grid.
Method GetColumnsCount * Returns the number of columns in the grid.
Method GetColumnsNames * Returns the headers of the columns in the grid.
Method GetErrorProviderText Returns the tooltip text of the error icon associated with the object.
Method GetRecordsCount * Returns the number of records in the grid.
Common Method GetROProperty Returns the current value of the description property from the object in the application.
Method GetRowsCount * Returns the number of rows in the grid.
MethodGetRowsPaths * Returns the paths of the rows in the grid.
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 property from the test object description.
Method GetVisibleText Returns the text from the specified area.
Method GroupByColumn * Groups table rows according to the specified column.
Common Method Highlight Highlights the object in the application.
Method HideColumn * Hides the specified column.
Method HideParentRow Hides the parent row, when the child grid is displayed.
Method HideRow * Hides the specified row.
Method MakeCellVisible Scrolls the specified cell into view if it is not visible in the grid.
Method MouseMove Moves the mouse pointer to the designated position over the object.
Method MoveCoulmn * Moves the specified column to the specified destination column's position.
Method MoveRow * Moves the specified row to the specified destination row's position.
Method OpenCellElement Selects the specified cell and opens a cell's pop-up cell element.
Method OpenCellRelation Opens the child table referenced by the link in the specified cell.
Method OpenSummaryDlg Opens the summary dialog box for the specified column.
Common Method Output Retrieves the current value of an item and stores it in a specified location.
Common Method RefreshObject Instructs UFT One 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 a grid.
Method SelectColumn Selects (clicks) the specified column header in a grid.
Method SelectRow Selects (clicks) the specified row header in a grid.
Method SetCellData Sets the contents of a cell with the specified string.
Method SetMultiCellData * Sets the contents of a cell in a multi-editor row with the specified string.
Method SetFilter Applies the specified filter string to the specified column.
Method SetSelection * Sets a rectangle shaped selection.
Common Method SetTOProperty Sets the value of the specified description property in the test object description.
Method ShowColumn * Makes the specified column visible in the grid.
Method ShowParentRow Displays the parent row, when the child grid is displayed.
Method ShowRow * Makes the specified row visible in the grid.
Method Sort Sorts the table contents according to the specified column.
Common Method ToString Returns a string that represents the test object.
Method Type Types the specified string in the object.
Method UnGroupByColumn * Ungroups table rows according to the specified column.
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 grid.
Common Property Exist Checks whether the object currently exists in the open application.
Common Property Object Accesses the native methods and properties of the object.
Property RowCount Returns the number of rows in the grid.

Back to top

 

ActivateCell Method

Description

Double-clicks the specified cell in a grid.

Syntax

object.ActivateCell Row, Column

For DevExpress Vertical Grids: object.ActivateCell rowPath, recordIndex, [cellCaption]

Arguments

Parameter Description
Row/rowPath

Required. A Variant.

The location of the row within the grid.

  • For Infragistics UltraWinGrid: The 0-based row number for top level bands. For child bands, specify the row with a string in the format:

            "n1;n2;...nX"

    where n is the row number in each band level.

  • For DevExpress Data Grids and Pivot Grids: The 0-based number of the row in the current view.

  • For DevExpress Vertical Grids: The row's path (string). Separate nested or multi-editor row names with semicolons(;). For example: "Price;Full Name;Category;Color"

  • For other grids: The 0-based number of the row.

Column/recordIndex

Required. A Variant.

The location of the column within the grid. In most cases, the column header name (string) or the column index (0-based number).

  • For Microsoft DataGrid: The 0-based column index (number).
  • For DevExpress Vertical Grids: The 0-based record index (number).
cellCaption

Required for multi-editor rows in DevExpress Vertical Grids. A String.

The caption of the cell within a multi-editor row in the grid.

Return Type

None

Example

Back to top

 

ActivateColumn Method

Description

Double-clicks the specified column header in a grid.

Syntax

object.ActivateColumn Column

Arguments

Parameter Description
Column

Required. A Variant.

The location of the column within the grid.

  • For Microsoft DataGrid: The 0-based column index.

  • For Infragistics UltraWinGrid, use the format:

           n;name

    where n is the band level (0-based) and name is the column header name or the column index (0-based).

  • For other grids, the value can be the column index (number) or column caption (string).

Return Type

None

IMPORTANT

This method is not supported for DevExpress Data Grid, Pivot Grid and Vertical Grid controls.

Example

Back to top

 

ActivateRow Method

Description

Double-clicks the specified row header in a grid.

Syntax

object.ActivateRow Row

Arguments

Parameter Description
Row

Required. A Variant.

The location of the row within the grid. The 0-based number of the row.

For Infragistics UltraWinGrid: The 0-based row number for top level bands. For child bands, specify the row with a string in the format:

        "n1;n2;...nX"

where n is the row number in each band level.

Return Type

None

IMPORTANT

This method is not supported for DevExpress Data Grid, Pivot Grid and Vertical Grid controls.

Example

Back to top

 

AddCellToSelection Method

Supported in UFT One versions 15.0.2 and later.

Description

Adds the specified cell to the existing selection.

Syntax

objectAddCellToSelection row, column

For DevExpress Vertical Grid: object.AddCellToSelection rowPath, recordIndex, [cellCaption]

Arguments

Parameter Description
row/rowPath

Required. A Variant.

The location of the row within the grid. Specify the 0-based number of the row in the current view.

For DevExpress Vertical Grids: The row's path (string). Separate nested or multi-editor row names with semicolons(;). For example: "Price;Full Name;Category;Color"

column/recordIndex

Required. A Variant.

The location of the column within the grid. Specify the column header name (string) or the column index (0-based number).

For DevExpress Vertical Grids: The 0-based record index (number).

cellCaption

Required for multi-editor rows in DevExpress Vertical Grids. A String.

The caption of the cell within a multi-editor row in the grid.

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Data Grid, Pivot Grid and Vertical Grid controls.

Example

Back to top

 

AddRow Method

Description

Adds a new row to the table band using the Add button for the corresponding band.

Syntax

object.AddRow AddButtonName, [Row]

Arguments

Parameter Description
AddButtonName Required. A Variant.
The name of the Add button corresponding to the band to which you want to add a row.
Row Optional. A Variant.
The band path that shows where the row is added. Separate band levels with semicolons(;). Row numbers in each band are 0-based.
For example: "4;0;2"

Return Type

None.

IMPORTANT

This method is supported only for Infragistics UltraWinGrid controls.

Example

Back to top

 

AddRowToSelection Method

Supported in UFT One versions 15.0.2 and later.

Description

Adds the specified row to the existing selection.

Syntax

object.AddRowToSelection row

For DevExpress Vertical Grids: object.AddRowToSelection rowPath

Arguments

Parameter Description
row/rowPath

Required. A Variant.

The location of the row within the grid. Specify the 0-based number of the row in the current view.

For DevExpress Vertical Grids: The row's path (string). Separate nested or multi-editor row names with semicolons(;). For example: "Price;Full Name;Category;Color"

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Data Grid, Pivot Grid and Vertical Grid controls.

Example

Back to top

 

Back Method

Description

Navigates back to the parent table.

Syntax

object.Back

Return Type

None.

IMPORTANT

This method is supported only for Microsoft Data Grid controls.

Example

Back to top

 

ClearGrouping Method

Supported in UFT One versions 15.0.2 and later.

Description

Clears the existing column grouping.

Syntax

object.ClearGrouping

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Data Grid controls.

Back to top

 

ClearSelection Method

Supported in UFT One versions 15.0.2 and later.

Description

Clears the existing selection in the grid.

Syntax

object.ClearSelection

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Data Grid, Vertical Grid, and Pivot Grid controls.

Back to top

 

Click Method

Description

Clicks an object.

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 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 = -9999
BUTTON Optional. A predefined constant or number.
The mouse button used to click the object.
Default value = micLeftBtn

Return Type

None

Example

Back to top

 

CollapseAllGroups Method

Supported in UFT One versions 15.0.2 and later.

Description

Collapses all group rows.

Syntax

object.CollapseAllGroups

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Data Grid controls.

Back to top

 

CollapseAllRows Method

Supported in UFT One versions 15.0.2 and later.

Description

Collapses all rows.

Syntax

object.CollapseAllRows

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Vertical Grid controls.

Back to top

 

CollapseRow Method

Description

Collapses the specified row.

Syntax

object.CollapseRow Row

For DevExpress Vertical Grids: object.CollapseRow rowPath

Arguments

Parameter Description
Row/rowPath

Required. A Variant.

The location of the row within the grid.

  • For Infragistics UltraWinGrid: The 0-based row number for top level bands. For child bands, specify the row with a string in the format:

            "n1;n2;...nX"

    where n is the row number in each band level.

  • For DevExpress Data Grids: The 0-based number of the row in the current view.

  • For DevExpress Vertical Grids: The row's path (string). Separate nested or multi-editor row names with semicolons(;). For example: "Price;Full Name;Category;Color"

  • For other grids: The 0-based number of the row.

Return Type

None.

IMPORTANT

This method is supported only for the following controls:

  • Microsoft Data Grid
  • Infragistics UltraWinGrid
  • ComponentOne: C1FlexGrid, C1TrueDBGrid.
  • DevExpress Data Grid, Vertical Grid (UFT One 15.0.2 and later)

Example

Back to top

 

DblClick Method

Description

Double-clicks an object

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

Example

Back to top

 

DeselectCell Method

Supported in UFT One versions 15.0.2 and later.

Description

Deselects the specified cell.

Syntax

objectDeselectCell row, column

For DevExpress Vertical Grid: object.DeselectCell rowPath, recordIndex, [cellCaption]

Arguments

Parameter Description
row/rowPath

Required. A Variant.

The location of the row within the grid. Specify the 0-based number of the row in the current view.

For DevExpress Vertical Grids: The row's path (string). Separate nested or multi-editor row names with semicolons(;). For example: "Price;Full Name;Category;Color"

column/recordIndex

Required. A Variant.

The location of the column within the grid. Specify the column header name (string) or the column index (0-based number).

For DevExpress Vertical Grids: The 0-based record index (number).

cellCaption

Required for multi-editor rows in DevExpress Vertical Grids. A String.

The caption of the cell within a multi-editor row in the grid.

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Data Grid, Pivot Grid and Vertical Grid controls.

Back to top

DeselectRow Method

Supported in UFT One versions 15.0.2 and later.

Description

Deselects the specified row.

Syntax

object.DeselectRow row

For DevExpress Vertical Grids: object.DeselectRow rowPath

Arguments

Parameter Description
row/rowPath

Required. A Variant.

The location of the row within the grid. Specify the 0-based number of the row in the current view.

For DevExpress Vertical Grids: The row's path (string). Separate nested or multi-editor row names with semicolons(;). For example: "Price;Full Name;Category;Color"

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Data Grid, Pivot Grid and Vertical Grid controls.

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


Default value = micLeftBtn

Return Type

None

Example

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 coordinates 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 coordinates 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 button that is released to drop the object.
Default value = micLeftBtn

Return Type

None

Example

Back to top

 

ExpandAllGroups Method

Supported in UFT One versions 15.0.2 and later.

Description

Expands all group rows.

Syntax

object.ExpandAllGroups

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Data Grid controls.

Back to top

 

ExpandAllRows Method

Supported in UFT One versions 15.0.2 and later.

Description

Expands all rows.

Syntax

object.ExpandAllRows

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Vertical Grid controls.

Back to top

 

ExpandRow Method

Description

Expands the specified row.

Syntax

object.ExpandRow Row

For DevExpress Vertical Grids: object.ExpandRow rowPath

Arguments

Parameter Description
Row/rowPath

Required. A Variant.

The location of the row within the grid.

  • For Infragistics UltraWinGrid: The 0-based row number for top level bands. For child bands, specify the row with a string in the format:

            "n1;n2;...nX"

    where n is the row number in each band level.

  • For DevExpress Data Grids: The 0-based number of the row in the current view.

  • For DevExpress Vertical Grids: The row's path (string). Separate nested or multi-editor row names with semicolons(;). For example: "Price;Full Name;Category;Color"

  • For other grids: The 0-based number of the row.

Return Type

None.

IMPORTANT

This method is supported only for the following controls:

  • Microsoft Data Grid
  • Infragistics UltraWinGrid
  • ComponentOne: C1FlexGrid, C1TrueDBGrid.
  • DevExpress Data Grid, Vertical Grid (UFT One 15.0.2 and later)

Example

Back to top

 

FireEvent Method

Description

Simulates an event on a .NET object.

Syntax

object.FireEvent EventName

 

Arguments

Parameter Description
EventName Required. A Variant.
The name of the event to simulate. The list of possible events depends on the object.
Required. None
The Args argument is passed to the constructor of the event's EventArgs object or the implementing class. Enter the values in a comma separated list. If no event arguments are required, you do not need to supply a value for the argument.

Return Type

None.

IMPORTANT

The event is sent to all listeners of the .NET object and does not affect the .NET object itself. For example, simulating a click event does not actually perform the click.

Example

Back to top

 

GetCellData Method

Description

Retrieves the contents of the specified cell in a grid.

Syntax

object.GetCellData Row, Column

For DevExpress Vertical Grid: object.GetCellData rowPath, recordIndex, [cellCaption]

Arguments

Parameter Description
Row/rowPath

Required. A Variant.

The location of the row within the grid.

  • For Infragistics UltraWinGrid: The 0-based row number for top level bands. For child bands, specify the row with a string in the format:

            "n1;n2;...nX"

    where n is the row number in each band level.

  • For DevExpress Data Grids and Pivot Grids: The 0-based number of the row in the current view.

  • For DevExpress Vertical Grids: The row's path (string). Separate nested or multi-editor row names with semicolons(;). For example: "Price;Full Name;Category;Color"

  • For other grids: The 0-based number of the row.

column/recordIndex

Required. A Variant.

The location of the column within the grid. Specify the column header name (string) or the column index (0-based number).

For Microsoft DataGrids: The 0-based column index (number).

For DevExpress Vertical Grids: The 0-based record index (number).

cellCaption

Required for multi-editor rows in DevExpress Vertical Grids. A String.

The caption of the cell within a multi-editor row in the grid.

Return Type

A String value.

Example

Back to top

 

GetCellProperty Method

Description

Returns the value of a grid cell property.

Syntax

object.GetCellProperty Row, Column, PropertyName

Arguments

Parameter Description
Row Required. A Variant.
The location of the row within the grid.
For Infragistics UltraWinGrid, specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.
For other grids, specify a 0-based number.
Column Required. A Variant.
The location of the column within the grid.
For Microsoft DataGrid, specify the column by its 0-based column index.
For Infragistics UltraWinGrid, use the column header name or the column index (0-based).
For other grids, the value can be the column index (number) or column caption (string).
PropertyName Required. A String value.

The name of the property, specified as a string.
Possible values:  

Property Name
Description
x
The X-coordinate of the specified cell relative to the table. 
y
The Y-coordinate of the specified cell relative to the table.
width
The width of the specified cell.
height
The height of the specified cell.
value
The content of the specified cell.
colname
The column header name of the specified cell.

   

Return Type

A Variant.

Returns the value of the specified property.

If the specified PropertyName is not one of the supported properties, a NOT_IMPLEMENTED error occurs.

IMPORTANT

This method is not supported for DevExpress controls.

Example

Back to top

GetChildRowsCount Method

Supported in UFT One versions 15.0.2 and later.

Description

Returns the number of child rows of the specified row in the grid.

Syntax

object.GetChildRowsCount rowPath, [includeHiddenRows]

Arguments

Parameter Description
rowPath Required. A String. The path to the row's location in the grid. Separate nested or multi-editor row names with semicolons(;). For example: "Price;Full Name;Category;Color"
includeHiddenRows

Optional. A Boolean value.

Indicates whether to include hidden rows in the child row count. (Default = false)

Return Type

An Integer.

IMPORTANT

This method is supported only for DevExpress Vertical Grid controls.

Back to top

GetChildRowsPaths Method

Supported in UFT One versions 15.0.2 and later.

Description

Returns the paths of the child rows of the specified row in the grid.

Syntax

object.GetChildRowsPaths rowPath, [includeHiddenRows]

Arguments

Parameter Description
rowPath Required. A String. The path to the row's location in the grid. Separate nested or multi-editor row names with semicolons(;). For example: "Price;Full Name;Category;Color"
includeHiddenRows

Optional. A Boolean value.

Indicates whether to include the paths of hidden rows. (Default = false)

Return Type

A list of strings.

IMPORTANT

This method is supported only for DevExpress Vertical Grid controls.

Back to top

GetColumnsCount Method

Supported in UFT One versions 15.0.2 and later.

Description

Returns the number of columns in the grid.

Syntax

object.GetColumnsCount [includeHiddenColumns]

Arguments

Parameter Description
includeHiddenColumns

Optional. A Boolean value.

Relevant only for DevExpress Data Grid controls.

Indicates whether to include the grid's hidden columns in the count. (Default = false)

Return Type

An Integer.

IMPORTANT

This method is supported only for DevExpress Data Grid and DevExpress Pivot Grid controls.

Back to top

GetColumnsNames Method

Supported in UFT One versions 15.0.2 and later.

Description

Returns the headers of the columns in the grid.

Syntax

object.GetColumnsNames [includeHiddenColumns]

Arguments

Parameter Description
includeHiddenColumns

Optional. A Boolean value.

Indicates whether to include the names of the grid's hidden columns. (Default = false)

Return Type

A list of strings.

IMPORTANT

This method is supported only for DevExpress Data Grid controls.

Back to top

 

GetErrorProviderText Method

Description

Returns the tooltip text of the error icon associated with the object.

Syntax

object.GetErrorProviderText

Return Type

A String value.

If no error provider control currently exists for the object, the method returns an empty string.

Example

Back to top

GetRecordsCount Method

Supported in UFT One versions 15.0.2 and later.

Description

Returns the number of records in the grid.

Syntax

object.GetRecordsCount

Return Type

An Integer.

IMPORTANT

This method is supported only for DevExpress Vertical Grid controls.

Back to top

GetRowsCount Method

Supported in UFT One versions 15.0.2 and later.

Description

Returns the number of columns in the grid.

Syntax

object.GetRowsCount [includeHiddenRows]

Arguments

Parameter Description
includeHiddenRows

Optional. A Boolean value.

Indicates whether to include the grid's hidden rows in the count. (Default = false)

Relevant only for DevExpress Data Grid controls.

Return Type

An Integer.

IMPORTANT

This method is supported only for DevExpress Data Grid and DevExpress Pivot Grid controls.

Back to top

GetRowsPaths Method

Supported in UFT One versions 15.0.2 and later.

Description

Returns the paths of the rows in the grid.

Syntax

object.GetRowsPaths [includeHiddenRows]

Arguments

Parameter Description
includeHiddenRows

Optional. A Boolean value.

Relevant only for DevExpress Data Grid and DevExpress Vertical Grid.

Indicates whether to include the paths of the grid's hidden rows. (Default = false)

Return Type

A list of strings.

IMPORTANT

This method is supported only for the following controls: DevExpress Data Grid, DevExpress Vertical Grid, DevExpress Pivot Grid.

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.

Indicates whether the text was found in the specified coordinates. Additionally, if the text is found, this method returns the coordinates of the rectangle containing the first instance of the text into the Left, Top, Right, and Bottom arguments.

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 node > 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, the APIs used in your application, and so on. 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 UFT One 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 UFT One 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).

Example

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

  • 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, the APIs used in your application, and so on. 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 UFT One 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 UFT One 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).

Example

Back to top

 

GroupByColumn Method

Supported in UFT One versions 15.0.2 and later.

Description

Group table rows according to the specified column.

Syntax

object.GroupByColumn Column

Arguments

Parameter Description
Column Required. A Variant.
The location of the column within the grid.
The value can be the column index (0-based number) or column caption (string).

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Data Grid controls.

Example

Back to top

HideColumn Method

Supported in UFT One versions 15.0.2 and later.

Description

Hides the specified column.

Syntax

object.HideColumn column

Arguments

Parameter Description
Column Required. A Variant.
The location of the column within the grid.
The value can be the column index (0-based number) or column caption (string).

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Data Grid controls.

Back to top

 

HideParentRow Method

Description

Hides the parent row, when the child grid is displayed.

Syntax

object.HideParentRow

Return Type

None.

IMPORTANT

This method is supported only for Microsoft Data Grid controls.

You can use the OpenCellRelation method to display the child table of a selected cell. You can use the ShowParentRow method to display a hidden parent row.

Example

Back to top

HideRow Method

Supported in UFT One versions 15.0.2 and later.

Description

Hides the specified row.

Syntax

object.HideRow rowPath

Arguments

Parameter Description
rowPath

Required. A String.

The path to the location of the row within the grid.

Separate nested or multi-editor row names with semicolons(;). For example: "Price;Full Name;Category;Color"

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Vertical Grid controls.

Back to top

 

MakeCellVisible Method

Description

Scrolls the specified cell into view if it is not visible in the grid.

Syntax

object.MakeCellVisible Row, Column

Arguments

Parameter Description
Row Required. A Variant.
The location of the row within the grid.
For Infragistics UltraWinGrid, specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.
For DevExpress Data Grid, specify the 0-based row number of the row in the current view.
For other grids, specify a 0-based number.
Column Required. A Variant.
The location of the column within the grid.
For Microsoft DataGrid, specify the column by its 0-based column index.
For Infragistics UltraWinGrid, use the column header name or the column index (0-based).
For other grids, the value can be the column index (number) or column caption (string).

Return Type

None

Example

Back to top

 

MouseMove Method

Description

Moves the mouse pointer to the designated position over the object.

Syntax

object.MouseMove X, Y

Arguments

Parameter Description
X Required. An integer value.
The position of the mouse pointer, expressed as x-coordinates (in pixels). Note that the specified coordinates are relative to the upper left corner of the object.
Y Required. An integer value.
The position of the mouse pointer, expressed as y-coordinates (in pixels). Note that the specified coordinates are relative to the upper left corner of the object.

Return Type

None

IMPORTANT

The MouseMove method may behave unexpectedly in a VMware environment.

Workaround: Add the following line to the VMware configuration file (<VM name>.vmx): vmmouse.present = "FALSE"
For more information, refer to the VMware support article, number 1691 - "Unexpected Cursor Behavior in Windows Virtual Machine with "Snap To" Mouse Control Panel Option Enabled", at: http://www.vmware.com/support/kb/enduser/std_alp.php.

Example

Back to top

MoveColumn Method

Supported in UFT One versions 15.0.2 and later.

Description

Moves the specified column to the specified destination column's position.

Syntax

object.MoveColumn sourceColumn, desntinationColumn, [insertAfter]

Arguments

Parameter Description
sourceColumn Required. A Variant.
The location of the column to move within the grid.
The value can be the column index (0-based number) or column caption (string).
destinationColumn Required. A Variant.
The new location for the column within the grid.
The value can be the column index (0-based number) or column caption (string).
insertAfter

Optional. A Boolean.

Indicates whether to insert the column in the grid after the specified destination column.

Default=false. The column is inserted before the specified column.

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Data Grid controls.

Back to top

MoveRow Method

Supported in UFT One versions 15.0.2 and later.

Description

Hides the specified row.

Syntax

object.MoveRow sourceRowPath, destinationRowPath, moveOptions

Arguments

Parameter Description
sourceRowPath

Required. A String.

The path to the location of the row to move within the grid.

Separate nested or multi-editor row names with semicolons(;). For example: "Price;Full Name;Category;Color"

destinationRowPath

Required. A String.

The path to the new location of the row within the grid.

Separate nested or multi-editor row names with semicolons(;). For example: "Price;Full Name;Category;Color"

moveOptions

Required. An Integer.

Indicates where to place the moved row relative to the specified destination.

Possible values: 

0 - MoveBefore. Place the moved row before the specified destination row.

1 - MoveToChildren. Place the moved row as a child of the specified destination row.

2 - MoveAfter. Place the moved row after the specified destination row.

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Vertical Grid controls.

Back to top

 

OpenCellElement Method

Description

Selects the specified cell and opens a cell's pop-up cell element.

Syntax

object.OpenCellElement Row, Column

Arguments

Parameter Description
Row Required. A Variant.
The 0-based row number.
Column Required. A Variant.
The location of the column within the grid.
The value can be the column index (0 -based number) or column caption (string).

Return Type

None.

IMPORTANT

This method is supported only for ComponentOne C1FlexGrid and C1TrueDBGrid controls.

Example

Back to top

 

OpenCellRelation Method

Description

Opens the child table referenced by the link in the specified cell.

Syntax

object.OpenCellRelation Row, Column

Arguments

Parameter Description
Row Required. A Variant.
The 0-based row number.
Column Required. A Variant.
The 0-based column number.

Return Type

None.

IMPORTANT

This method is supported only for Microsoft Data Grid controls.

Example

Back to top

 

OpenSummaryDlg Method

Description

Opens the summary dialog box for the specified column.

Syntax

object.OpenSummaryDlg Level, Column

Arguments

Parameter Description
Level Required. A Variant.
The band level for which you want to open the dialog box.
Column Required. A Variant.
The column header name or the column index (0-based).

Return Type

None.

IMPORTANT

This method is supported only for Infragistics UltraWinGrid controls.

Example

Back to top

 

SelectCell Method

Description

Selects (clicks) the specified cell in a grid.

Syntax

object.SelectCell Row, Column

For DevExpress Vertical Grid: object.SelectCell rowPath, recordIndex, [cellCaption]

Arguments

Parameter Description
Row/rowPath

Required. A Variant.

The location of the row within the grid.

  • For Infragistics UltraWinGrid: The 0-based row number for top level bands. For child bands, specify the row with a string in the format:

            "n1;n2;...nX"

    where n is the row number in each band level.

  • For DevExpress Data Grids and Pivot Grids: The 0-based number of the row in the current view.

  • For DevExpress Vertical Grids: The row's path (string). Separate nested or multi-editor row names with semicolons(;). For example: "Price;Full Name;Category;Color"

  • For other grids: The 0-based number of the row.

Column/recordIndex

Required. A Variant.

The location of the column within the grid. In most cases, the column header name (string) or the column index (0-based number).

  • For Microsoft DataGrid: The 0-based column index (number).
  • For DevExpress Vertical Grids: The 0-based record index (number).
cellCaption

Required for multi-editor rows in DevExpress Vertical Grids. A String.

The caption of the cell within a multi-editor row in the grid.

Return Type

None

Example

Back to top

 

SelectColumn Method

Description

Selects (clicks) the specified column header in a grid.

Syntax

object.SelectColumn Column

Arguments

Parameter Description
Column Required. A Variant.
The location of the column within the grid.
For Microsoft DataGrid, specify the column by its 0-based column index.
For Infragistics UltraWinGrid, use the format:
       n;name
where n is the band level (0-based) and name is the column header name or the column index (0-based).
For other grids, the value can be the column index (number) or column caption (string).

Return Type

None

IMPORTANT

This method is not supported for DevExpress Data Grid, Pivot Grid and Vertical Grid controls.

Example

Back to top

 

SelectRow Method

Description

Selects (clicks) the specified row header in a grid.

Syntax

object.SelectRow Row

For DevExpress Vertical Grid: object.SelectRow rowPath

Arguments

Parameter Description
Row/rowPath

Required. A Variant.

The location of the row within the grid.

  • For Infragistics UltraWinGrid: The 0-based row number for top level bands. For child bands, specify the row with a string in the format:

            "n1;n2;...nX"

    where n is the row number in each band level.

  • For DevExpress Data Grids and Pivot Grids: The 0-based number of the row in the current view.

  • For DevExpress Vertical Grids: The row's path (string). Separate nested or multi-editor row names with semicolons(;). For example: "Price;Full Name;Category;Color"

  • For other grids: The 0-based number of the row.

Return Type

None

Example

Back to top

 

SetCellData Method

Description

Sets the contents of a cell with the specified string.

Syntax

object.SetCellData Row, Column, Data, [Type]

For DevExpress Vertical Grid: object.SetCellData rowPath, recordIndex, [cellCaption]

Arguments

Parameter Description
Row/rowPath

Required. A Variant.

The location of the row within the grid.

  • For Infragistics UltraWinGrid: The 0-based row number for top level bands. For child bands, specify the row with a string in the format:

            "n1;n2;...nX" where n is the row number in each band level.

  • For DevExpress Data Grids and Pivot Grids: The 0-based number of the row in the current view.

  • For DevExpress Vertical Grids: The row's path (string). Separate nested or multi-editor row names with semicolons(;). For example: "Price;Full Name;Category;Color"

  • For other grids: The 0-based number of the row.

Column/recordIndex

Required. A Variant.

The location of the column within the grid. Specify the column header name (string) or the column index (0-based number).

For Microsoft DataGrids: The 0-based column index (number).

For DevExpress Vertical Grids: The 0-based record index (number).

cellCaption

Required for multi-editor rows in DevExpress Vertical Grids. A String.

The caption of the cell within a multi-editor row in the grid.

Data Required. A String value.

The contents to be entered into the specified cell.

For dimmed check boxes, specify the value: NULL (without quotes).

Type Optional. A Boolean value.
Relevant only for ComponentOne C1FlexGrid and C1TrueDBGrid controls:

Indicates whether the data is entered into the cell by typing.
Possible values:
True: Types the data into the cell one character at a time.
False: (default) Enters the complete string into the cell.

Default value = False

Return Type

None.

IMPORTANT

This method is recorded only after you move the focus from the edited cell to another cell.

Example

Back to top

SetMultiCellData Method

Supported in UFT One versions 15.0.2 and later.

Description

Sets the contents of a cell in a multi-editor row with the specified string.

Syntax

object.SetMultiCellData rowPath, recordIndex, [cellCaption]

Arguments

Parameter Description
rowPath

Required. A String.

The path to the row's location within the grid. Separate nested or multi-editor row names with semicolons(;). For example: "Price;Full Name;Category;Color"

recordIndex

Required. An Integer.

The 0-based record index of the column within the grid.

cellCaption

Required. A String.

The caption of the cell within the multi-editor row in the grid.

Data Required. A String value.

The contents to be entered into the specified cell.

Return Type

None.

IMPORTANT

This method is supported only on DevExpress Vertical Grid controls.

 

SetFilter Method

Description

Applies the specified filter string to the specified column.

Syntax

object.SetFilter Level, Column, Value

Arguments

Parameter Description
Level Optional. A Variant.

The band level.

Column

Required. A Variant.

The location of the column within the grid.
For Infragistics UltraWinGrid, use the format:
       n;name
where n is the band level (0-based) and name is the column header name or the column index (0-based).
For ComponentOne grids, the value can be the column index (number) or column caption (string).

The column index (number) or column caption (string).

Value Required. A Variant.
The filter name or a string defining the filter.

Return Type

None.

IMPORTANT

This method is supported only for Infragistics UltraWinGrid, ComponentOne C1FlexGrid, and ComponentOne C1TrueDBGrid controls.

Example

Back to top

SetSelection Method

Supported in UFT One versions 15.0.2 and later.

Description

Sets a rectangle-shaped selection.

Syntax

object.SetSelection X, Y, Width, Height

Arguments

Parameter Description
X

Required. An Integer.

The 0-based row index of the cell at the top left corner of the rectangle to select.

Y

Required. An Integer.

The 0-based column index of the cell at the top left corner of the rectangle to select.

Width

Required. An Integer.

The positive width of the rectangle to select (in cells).

Height

Required. An Integer.

The positive height of the rectangle to select (in cells).

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Pivot Grid controls.

Back to top

 

ShowColumn Method

Supported in UFT One versions 15.0.2 and later.

Description

Makes the specified column visible in the grid.

Syntax

object.ShowColumn columnName

Arguments

Parameter Description
ColumnName Required. A String.
The location of the column within the grid. Specify the column caption.

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Data Grid controls.

Back to top

 

ShowParentRow Method

Description

Displays the parent row, when the child grid is displayed.

Syntax

object.ShowParentRow

Return Type

None.

IMPORTANT

This method is supported only for Microsoft Data Grid controls. You can use the SwfTable.OpenCellRelation method to display the child table of a selected cell. You can use the SwfTable.HideParentRow method to hide a displayed parent row.

Example

Back to top

ShowRow Method

Supported in UFT One versions 15.0.2 and later.

Description

Makes the specified row visible in the grid.

Syntax

object.ShowRow rowPath

Arguments

ParameterDescription
rowPath

Required. A String.

The path to the location of the row within the grid.

Separate nested or multi-editor row names with semicolons(;). For example: "Price;Full Name;Category;Color"

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Vertical Grid controls.

Back to top

 

Sort Method

Description

Sorts the table contents according to the specified column.

Syntax

object.Sort Level, Column, Order

Arguments

ParameterDescription
Level Required. A Variant.
Relevant only for Infragistics UltraWinGrid controls:

The band level for which you want to open the dialog box.
Column

Required. A Variant.

The location of the column within the grid. Specify the column header name (string) or the column index (0-based).

For Microsoft DataGrid, specify the column by its 0-based column index.

Order Required. A Variant.
For Infragistics UltraWinGrid controls:

The sorting order.
Possible values:       
       "Ascending"
       "Descending" (default)
Note: The value may also be a numeric code representing special sort options.

 

Return Type

None.

IMPORTANT

This method is supported only for Infragistics UltraWinGrid, ComponentOne C1FlexGrid, and ComponentOne C1TrueDBGrid controls.

Example

Back to top

 

Type Method

Description

Types the specified string in the object.

Syntax

object.Type KeyboardInput

Arguments

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

Example

Back to top

 

UnGroupByColumn Method

Supported in UFT One versions 15.0.2 and later.

Description

Ungroups table rows according to the specified column.

Syntax

object.UnGroupByColumn columnName

Arguments

ParameterDescription
ColumnName Required. A String.
The location of the column within the grid. Specify the column caption.

Return Type

None.

IMPORTANT

This method is supported only for DevExpress Data Grid controls.

Example

Back to top

 

ColumnCount Property

Description

Returns the number of columns in the grid.

Syntax

object.ColumnCount

Value Type

An integer value.

Property type

Read-only property

IMPORTANT

In UltraWinGrid controls, this property returns the number of columns in the current band.

Back to top

 

RowCount Property

Description

Returns the number of rows in the grid.

Syntax

object.RowCount

Value Type

A long integer value.

Property type

Read-only property

IMPORTANT

In UltraWinGrid controls, this property returns the number of rows in the current band.

Back to top

See also: