Xceed Grid Methods

Applies to TestComplete 15.70, last modified on December 17, 2024

When testing Xceed Grid controls, you can use specific methods of the corresponding test object as well as methods that TestComplete applies to all test and onscreen objects. All of these methods are listed below. The methods are organized into categories: Standard, Extended, RTTI, Debug Agent and others. For more information about this, see Categories of Object Methods and Properties.

Method List   | View ↓

By category

Object-specific methods only

Alphabetical order

Standard

This category includes methods that TestComplete applies to all test objects.

Name Description
Child Returns a child object by its index.
Find Searches for a child object that has the specified property values.
FindAll Returns an array of child objects that have the specified property values.
FindAllChildren Returns an array of child objects that have the specified property values.
FindChild Searches for a child object that has the specified property values.
FindChildEx Searches for a child object that has the specified property values during the specified timeout period.
FindEx Searches for a child object that has the specified property values during the specified timeout period.
FindId Returns a child object by its identifier.
FindRow Returns the index of the row holding the specified value within the specified column.
ObjectFromPoint Returns the window or the onscreen object that contains the pixel with the specified coordinates.
Picture Captures the image of the specified rectangular area of the object.
Refresh Refreshes the child object list.
ScreenToWindow Converts screen coordinates to coordinates relative to the object.
Validate Obsolete. Generates the OnValidate event for the object.
WaitChild Waits until the specified child object becomes available during the timeout period.
WaitProperty Waits until the specified object property achieves the specified value during the timeout period.
WindowToScreen Converts coordinates relative to the object to screen coordinates.
Actions

This category includes methods that simulate user actions on the tested controls.

Name Description
Click Simulates a click of the left mouse button over the object.
ClickCell Simulates a click of the left mouse button on the specified cell.
ClickCellR Simulates a click of the right mouse button on the specified cell.
ClickCellRXY Simulates a click of the right mouse button at the point (X, Y) within the specified cell.
ClickCellXY Simulates a click of the left mouse button at the point (X, Y) within the specified cell.
ClickColumnHeader Simulates a click of the left mouse button on the header of the specified column.
ClickColumnHeaderR Simulates a click of the right mouse button on the header of the specified column.
ClickColumnHeaderRXY Simulates a click of the right mouse button at the point (X, Y) within the specified column header.
ClickColumnHeaderXY Simulates a click of the left mouse button at the point (X, Y) within the specified column header.
ClickM Simulates a click of the middle mouse button over the object.
ClickNewRowCell Simulates a click of the left mouse button within the specified cell of the new grid row.
ClickNewRowCellR Simulates a click of the right mouse button within the specified cell of the new grid row.
ClickNewRowCellRXY Simulates a click of the right mouse button at the specified point within the specified cell of the new grid row.
ClickNewRowCellXY Simulates a click of the left mouse button at the specified point within the specified cell of the new grid row.
ClickNewRowIndicator Simulates a click of the left mouse button on the indicator of the new grid row.
ClickNewRowIndicatorR Simulates a click of the right mouse button on the indicator of the new grid row.
ClickR Simulates a click of the right mouse button over the object.
ClickRowIndicator Simulates a click of the left mouse button on the indicator of the specified row.
ClickRowIndicatorR Simulates a click of the right mouse button on the indicator of the specified row.
CollapseChildView Collapses the specified child table.
CollapseGroup Collapses the specified group.
DblClick Simulates a double-click of the left mouse button over the object.
DblClickCell Simulates a double-click of the left mouse button on the specified cell.
DblClickCellR Simulates a double-click of the right mouse button on the specified cell.
DblClickCellRXY Simulates a double-click of the right mouse button at the point (X, Y) within the specified cell.
DblClickCellXY Simulates a double-click of the left mouse button at the point (X, Y) within the specified cell.
DblClickColumnHeader Simulates a double-click of the left mouse button on the header of the specified column.
DblClickColumnHeaderR Simulates a double-click of the right mouse button on the header of the specified column.
DblClickColumnHeaderRXY Simulates a double-click of the right mouse button at the point (X, Y) within the specified column header.
DblClickColumnHeaderXY Simulates a double-click of the left mouse button at the point (X, Y) within the specified column header.
DblClickM Simulates a double-click of the middle mouse button over the object.
DblClickNewRowCell Simulates a double-click of the left mouse button within the specified cell of the new grid row.
DblClickNewRowCellR Simulates a double-click of the right mouse button within the specified cell of the new grid row.
DblClickNewRowCellRXY Simulates a double-click of the right mouse button at the point (X,Y) within the specified cell of the new grid row.
DblClickNewRowCellXY Simulates a double-click of the left mouse button at the point (X,Y) within the specified cell of the new grid row.
DblClickNewRowIndicator Simulates a double-click of the left mouse button on the indicator of the new grid row.
DblClickNewRowIndicatorR Simulates a double-click of the right mouse button on the indicator of the new grid row.
DblClickR Simulates a double-click of the right mouse button over the object.
DblClickRowIndicator Simulates a double-click of the left mouse button on the indicator of the specified tree list row.
DblClickRowIndicatorR Simulates a double-click of the right mouse button on the indicator of the specified tree list row.
Drag Simulates a dragging event performed with the left mouse button.
DragM Simulates a dragging event performed with the middle mouse button.
DragR Simulates a dragging event performed with the right mouse button.
ExpandChildView Expands or collapses the specified child table.
ExpandGroup Expands or collapses the specified group.
HoverMouse Simulates moving the mouse pointer to the specified position within an object.
HoverMouseCell Moves the mouse pointer to the specified grid cell.
HoverMouseColumnHeader Moves the mouse pointer to the header of the specified grid column.
HoverMouseNewRowCell Moves the mouse pointer to the specified cell of the new grid row.
HoverMouseNewRowIndicator Moves the mouse pointer to the indicator of the new grid row.
HoverMouseRowIndicator Moves the mouse pointer to the indicator of the specified grid row.
Keys Sends a keystroke to an object.
MouseWheel Simulates rotation of the mouse wheel over an object.
SetFocus Moves the input focus to an object.
<Name Mapping>

These methods are available only if the test object has been mapped (see Name Mapping). You can use them in your tests, but they are not displayed in the Object Browser panel.

Name Description
AddNamedChild Adds the specified child object to Name Mapping.
GetUnderlyingObject Returns the test object, to which the given mapping item corresponds.
RefreshMappingInfo Instructs TestComplete to re-identify the mapped object using the identification information specified in Name Mapping.
RemoveNamedChild Deletes the specified child mapped object from Name Mapping.
WaitAliasChild Waits until the child object with the specified alias becomes available during the timeout period.
WaitNamedChild Waits until a child object with the specified mapped name becomes available during the timeout period.
Other Categories

If TestComplete has access to internal methods, properties and files of your tested application (that is, if it is an Open Application), you can call the internal methods and properties as methods and properties of the appropriate test objects. You can view these properties and methods in corresponding categories (Private, Public, RTTI, Debug Agent, Firefox, and so on). These methods and properties are not described in the TestComplete help file. For more information on them, please see the documentation for the development tools that was used to create the application under test.

See Also

Xceed Grid Support

Highlight search results