ClickCell Action (Grid Controls)

Applies to TestComplete 14.60, last modified on April 22, 2021
This method is not supported in web tests (including cross-platform web tests) that use XPath expressions and CSS selectors to locate web elements. This method can be only used in tests that locate web objects by using internal identification properties provided by TestComplete.

Description

Use the ClickCell action to simulate a click of the left mouse button over the grid cell in the specified row and column.

Declaration

TestObj.ClickCell(Row, Column, Shift)

TestObj A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section
Row [in]    Required    Integer    
Column [in]    Required    Variant    
Shift [in]    Optional    TShiftKey Default value: skNoShift   
Result None

Applies To

The method is applied to the following objects:

AngularUI Grid, Borland String Grid, Borland TDBGrid and 34 more objects

View Mode

This method is available in the Object Browser panel and in other panels and dialogs in both Basic and Advanced view modes.

Parameters

The method has the following parameters:

Row

Specifies the zero-based index of the desired data row. The first visible row has index 0, the second - 1, and so on. Index of the last visible row is wRowCount - 1.

Borland TDBGrid: To be able to work with cells in rows that are situated out of the grid’s visible area, you should first scroll the grid so that the needed row becomes visible. For more information, see the Borland TDBGrid object description.

Column

Specifies the column that contains the desired cell. This parameter takes either the column’s index, or its caption.

The index is zero-based and corresponds to the column’s position within the object's internal columns collection rather than the column’s visible position in the object.

The caption can contain asterisk (*) or question mark (?) wildcards or regular expressions. The asterisk corresponds to a string of any length, the question mark corresponds to any single character. To specify more complicated parts of a caption, use regular expressions.

The caption can be case-sensitive or case-insensitive depending on the value of the Use case-sensitive parameters project setting.

XtraVerticalGrid: The XtraVerticalGrid control may contain multi-editor columns. These columns contain several headers (or nested columns) within each column. TestComplete considers these nested columns as ordinary columns, and both types of columns share the same index space.

The following image illustrates a typical structure of the XtraVerticalGrid control:

Shift

Sets whether the Shift, Alt or Ctrl keys are pressed during the click event (see TShiftKey). By default, this parameter is skNoShift (the shift keys are not pressed).

Result Value

None.

Remarks

  • If the specified cell is not found or is not displayed in the grid, ClickCell fails and posts an error message to the log.

  • For Telerik RadGridView v. 2011.1: TestComplete may be unable to interact with cells in the last row of the grid.

  • For Developer Express XtraGrid v. 16.1: In certain cases, the method may fail if the target cell is not currently visible in the grid (scrolled out of view). If this happens, you can work around the issue by explicitly scrolling the grid to the target cell before simulating a click.

Example

The following example demonstrates how to use the ClickCell action in scripts:

JavaScript
JScript
Python
VBScript
DelphiScript
C++Script, C#Script

JavaScript

function ClickGridCell()
{
  var p, w;
  // Obtain the grid object
  p = Sys.Process("DataGridViewSample");
  w = p.WinFormsObject("Form1").WinFormsObject("dataGridView1");
  // Call a control-specific method
  w.ClickCell(0, "Customer Name");
  // Assign value to a control-specific property
  w.$set("wValue", 0, "Customer Name", "Samuel Clemens");
}

JScript

function ClickGridCell()
{
  var p, w;
  // Obtain the grid object
  p = Sys.Process("DataGridViewSample");
  w = p.WinFormsObject("Form1").WinFormsObject("dataGridView1");
  // Call a control-specific method
  w.ClickCell(0, "Customer Name");
  // Assign value to a control-specific property
  w.wValue(0, "Customer Name") = "Samuel Clemens";
}

Python

def ClickGridCell():
  # Obtain the grid object
  p = Sys.Process("DataGridViewSample")
  w = p.WinFormsObject("Form1").WinFormsObject("dataGridView1")
  # Call a control-specific method
  w.ClickCell(0, "Customer Name")
  # Assign value to a control-specific property
  w.wValue[0, "Customer Name"] = "Samuel Clemens"

VBScript

Sub ClickGridCell
  Dim p, w
  ' Obtain the grid object
  Set p = Sys.Process("DataGridViewSample")
  Set w = p.WinFormsObject("Form1").WinFormsObject("dataGridView1")
  ' Call a control-specific method
  Call w.ClickCell(0, "Customer Name")
  ' Assign value to a control-specific property
  w.wValue(0, "Customer Name") = "Samuel Clemens"
End Sub

DelphiScript

procedure ClickGridCell;
var p, w : OleVariant;
begin
  // Obtain the grid object
  p := Sys.Process('DataGridViewSample');
  w := p.WinFormsObject('Form1').WinFormsObject('dataGridView1');
  // Call a control-specific method
  w.ClickCell(0, 'Customer Name');
  // Assign value to a control-specific property
  w.wValue[0, 'Customer Name'] := 'Samuel Clemens';
end;

C++Script, C#Script

function ClickGridCell()
{
  var p, w;
  // Obtain the grid object
  p = Sys["Process"]("DataGridViewSample");
  w = p["WinFormsObject"]("Form1")["WinFormsObject"]("dataGridView1");
  // Call a control-specific method
  w["ClickCell"](0, "Customer Name");
  // Assign value to a control-specific property
  w["wValue"](0, "Customer Name") = "Samuel Clemens";
}

See Also

ClickCell Action (Specific to DevExpressQuantumGrid Controls)
ClickCell Action (Specific to Qt TableWidget Controls)
DblClickCell Action (Grid Controls)

Highlight search results