| 1 Test

Working With Developer Express QuantumGrid - Selecting Cells

April 17, 2007

One of the actions you'll perform most often on a grid is selecting
cells. This article provides an example that selects grid cells on the
QuantumGrid control by Developer Express.

To perform this task, we will use the following internal properties of the TcxGrid object (TcxGrid is the class name of the QuantumGrid control):

ViewObj.Controller.FocusedColumn or ViewObj.Controller.FocusedColumnIndex - Using these properties you can move the focus to the specified column or obtain the column object that corresponds to the focused column in a view (the QuantumGrid control can contain several row levels. Each level has a view that defines how the data is displayed).

The FocusedColumn property returns the column object. The FocusedColumnIndex returns the index (zero-based) of the focused column.

ViewObj.Controller.FocusedRowIndex - Specifies the index of the focused row for a view.
GridObj.ActiveView - Returns the view object that corresponds to the root level.

Note: in order for TestComplete to be able to access these properties, the tested application must be compiled as an Open Application with debug information.

In addition, the property code must be included into the application’s binary file. The problem is that Delphi’s (or C++Builder’s) smart linker excludes methods and properties that are not used within the application. So, it is possible that the mentioned properties are not included into the application’s executable, or the application provides limited access to them (for instance, a read/write property can be seen as read-only or write-only).

To solve the problem, you can create a virtual method in your code that will call the needed properties. For example, you can use the following code:

In the example, we typecast the cxGrid1.ActiveView object to the TcxGridDBTableView type. In your application, the type name must conicinde with the view data type.

Note that the cell selection is only possible if the grid displays data in row selection mode. This mode is active, if the view’s ViewObj.OptionsView.CellSelect is set to False. If you are not sure which mode the tested grid functions, you may ask the tested application’s developer. Also, you can determine the mode visually by watching the grid’s behavior when you are navigating through the records. If the grid highlights whole rows rather than individual cells, then the row selection mode is active and you cannot simulate the cell selection.

Below is a sample code demonstrates the cell selection within the QuantumGrid control. The sample contains the following routines:

Main - The “main&Rdquo; routine of the sample. It obtains the scripting object that corresponds to the tested grid control and then calls the SelectGridCell routine that performs the selection.
SelectGridCell - Selects the specified grid cell. The routine uses the following parameters:
- grid - The scripting object that corresponds to the tested grid.
- view - The view object that contains the desired cell. If this parameter is Nothing (VBScript), null (JScript, C++Script, C#Script) or nil (DelphiScript), the routine assumes that you are working with the view associated with the root level.
- rowIndex - A zero-based index of the desired row.
- columnId - Either caption of the desired column, or column index (zero-based) among other visible columns.
The routine performs the following actions:
- If the view parameter is not specified, the routine uses the internal ActiveView property of the grid control to obtain the view that corresponds to the grid’s root level.
- Then, the routine calls the GetColumn function to obtain the column object, which corresponds to the desired column, and assigns this object to the Controller.FocusedColumn property of the specified view.
- Then, the routine assigns the specified row index to the view’s Controller.FocusedRowIndex property.
GetColumn - A helper routine that returns a column object by the column’s caption or by column index among other visible columns (the index is zero-based).

' [TestComplete VBScript] Sub Main Set p = Sys.Process("Project1") Set Grid = p.VCLObject("Form1").VCLObject("cxGrid1") ' Select a cell Call SelectGridCell(Grid, Nothing, 4, 3) End Sub ' Select grid cell Sub SelectGridCell(grid, view, rowIndex, columnId) ' Obtain the view object If view Is Nothing Then Set view = grid.ActiveView End If ' Select the column view.Controller.FocusedColumn = GetColumn(grid, view, columnId) ' Select the row view.Controller.FocusedRowIndex = rowIndex End Sub ' Obtain column object Function GetColumn(grid, view, columnId) Dim Columns, i ' Get the view If view Is Nothing Then Set view = grid.ActiveView End If ' Check type of the columnId parameter If VarType(columnId) = varOleStr Then ' If columnId is a string, ' then search for column by its caption For i = 0 to view.ColumnCount - 1 If view.Columns(i).Caption = columnId Then Set GetColumn = view.Columns(i) Exit For End If Next Else ' If columnId is an integer, ' then search for column by its index For i = 0 to view.ColumnCount - 1 If view.Columns(i).VisibleIndex = columnId Then Set GetColumn = view.Columns(i) Exit For End If Next End If End Function

' [TestComplete JScript] function Main() { var p, Grid, r; p = Sys.Process("Project1"); Grid = p.VCLObject("Form1").VCLObject("cxGrid1"); // Select cell SelectGridCell(Grid, null, 4, 3); } // Select grid cell function SelectGridCell(grid, view, rowIndex, columnId) { // Obtain the view object if (view == null) view = grid.ActiveView; // Select the column view.Controller.FocusedColumn = GetColumn(grid, view, columnId); // Select the row view.Controller.FocusedRowIndex = rowIndex; } // Obtain column object function GetColumn(grid, view, columnId) { var i; // Get the view if (view == null) view = grid.ActiveView; // Check type of the columnId parameter if (VarType(columnId) == varOleStr) { // If columnId is a string, // then search for column by its caption for (i = 0; i < view.ColumnCount; i++) if (view.Columns(i).Caption == columnId) return view.Columns(i); } else { // If columnId is an integer, // then search for column by its index for (i = 0; i < view.ColumnCount; i++) if (view.Columns(i).VisibleIndex == columnId) return view.Columns(i); } }

' [TestComplete DelphiScript] procedure SelectGridCell(grid, view, rowIndex, columnId); forward; function GetColumn(grid, view, columnId): Variant; forward; procedure Main; var p, Grid : OleVariant; begin p := Sys.Process('Project1'); Grid := p.VCLObject('Form1').VCLObject('cxGrid1'); // Search for a cell SelectGridCell(Grid, nil, 4, 3); end; // Select grid cell procedure SelectGridCell(grid, view, rowIndex, columnId); begin // Obtain the view object if view = nil then view := grid.ActiveView; // Select the column view.Controller.FocusedColumn := GetColumn(grid, view, columnId); // Select the row view.Controller.FocusedRowIndex := rowIndex; end; // Obtain column object function GetColumn(grid, view, columnId): Variant; var i: Variant; begin // Get the view if view = nil then view := grid.ActiveView; // Check type of the columnId parameter if VarType(columnId) = varOleStr then begin // If columnId is a string, // then search for column by its caption for i := 0 to view.ColumnCount - 1 do if view.Columns[i].Caption = columnId then Result := view.Columns[i]; end else // If columnId is an integer, // then search for column by its index for i := 0 to view.ColumnCount - 1 do if view.Columns[i].VisibleIndex = columnId then Result := view.Columns[i]; end;

' [TestComplete C++Script, C#Script] function Main() { var p, Grid; p = Sys["Process"]("Project1"); Grid = p["VCLObject"]("Form1")["VCLObject"]("cxGrid1"); // Select cell SelectGridCell(Grid, null, 4, 3); } // Select grid cell function SelectGridCell(grid, view, rowIndex, columnId) { // Obtain the view object if (view == null) view = grid["ActiveView"]; // Select the column view["Controller"]["FocusedColumn"] = GetColumn(grid, view, columnId); // Select the row view["Controller"]["FocusedRowIndex"] = rowIndex; } // Obtain column object function GetColumn(grid, view, columnId) { var i; // Get the view if (view == null) view = grid["ActiveView"]; // Check type of the columnId parameter if (VarType(columnId) == varOleStr) { // If columnId is a string, // then search for column by its caption for (i = 0; i < view["ColumnCount"]; i++) if (view["Columns"](i)["Caption"] == columnId) return view["Columns"](i); } else { // If columnId is an integer, // then search for column by its index for (i = 0; i < view["ColumnCount"]; i++) if (view["Columns"](i)["VisibleIndex"] == columnId) return view["Columns"](i); } }

Working With Developer Express QuantumGrid - Selecting Cells

Products

Additional Links