| 1 Test

Working With Developer Express Quantum Grid - Getting Cell Values

April 19, 2007

To obtain values displayed in cells of the Developer Express
QuantumGrid control, you should use the internal methods and proeprties
of the grid. This article describes these properties and contains
sample code that demonstrates how you can obtain the cell values.

To get cell values, TestComplete should have access to the internal methods and properties of the TcxGrid object. TcxGrid is the class name of the QuantumGrid control. That is, the tested application must be compiled as an Open Application with debug information.

QuantumGrid may contain several node levels. To determine how the data is displayed by a level, the QuantumGrid use view objects. To obtain the text displayed in a particular cell, use the following method of the view object:

ViewObj.DataController.DisplayTexts(RowIndex, ColumnIndex)

This method returns the text that is shown in the grid cells. The RowIndex and ColumnIndex parameters specify the row and column indexes of the cell. Both indexes are zero-based.

The following sample demonstrates how you can use this method to obtain cell values. The sample contains the following routines:

Main - The “main” routine of the sample. It contains the scripting object that corresponds to the tested grid object, calls the GetCellValue function to obtain the cell’s text and then posts the value returned by this function to the test log.
GetCellValue - This function returns the text of the specified the grid cell. The function uses the following parameters:
- grid - The scripting object that corresponds to the tested grid control.
- view - The view object that is used to display the data. 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 - The caption of the desired column or the column index (zero-based) among other visible columns.
The routine performs the following actions:
- Checks if the view parameter is null and, if it is, uses the grid’s ActiveView property to obtain the view object that corresponds to the root level.
- Calls the GetColumn script function to obtain the column object for the desired cell.
- Use the view object’s ViewData.Rows(rowIndex) property to obtain the row object that corresponds to the row containing the desired cell.
- Calls the view’s DataController.DisplayTexts method to obtain the cell’s text.
GetColumn - A helper routine that is used to obtain a column object by the column caption or index.

' [TestComplete VBScript] Sub Main Set p = Sys.Process("Project1") Set Grid = p.VCLObject("Form1").VCLObject("cxGrid1") ' Obtain the cell value s = GetCellValue(Grid, Nothing, 4, 2) ' Post the value to the log Log.Message s End Sub ' Obtain cell value Function GetCellValue(grid, view, rowIndex, columnId) Dim column ' Obtain the view If view Is Nothing Then Set view = grid.ActiveView End If ' Get the column object Set column = GetColumn(grid, view, columnId) ' Get the row object Set row = view.ViewData.Rows(rowIndex) ' Get the cell text GetCellValue = view.DataController.DisplayTexts(row.RecordIndex, column.Index) End Function ' 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, s; p = Sys.Process("Project1"); Grid = p.VCLObject("Form1").VCLObject("cxGrid1"); // Set Grid = GetGrid1 // Obtain the cell value s = GetCellValue(Grid, null, 4, 2); // Post the value to the log Log.Message(s); } // Obtain cell value function GetCellValue(grid, view, rowIndex, columnId) { var column, row; // Obtain the view if (view == null) view = grid.ActiveView; // Get the column object column = GetColumn(grid, view, columnId); // Get the row object row = view.ViewData.Rows(rowIndex); // Get the cell text return view.DataController.DisplayTexts(row.RecordIndex, column.Index); } // 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] function GetCellValue(grid, view, rowIndex, columnId): Variant; forward; function GetColumn(grid, view, columnId): Variant; forward; procedure Main; var p, Grid, s : OleVariant; begin p := Sys.Process('Project1'); Grid := p.VCLObject('Form1').VCLObject('cxGrid1'); // Obtain the cell value s := GetCellValue(Grid, nil, 4, 2); // Post the value to the log Log.Message(s); end; // Obtain cell value function GetCellValue(grid, view, rowIndex, columnId): Variant; var column, row: Variant; begin // Obtain the view if view = nil then view := grid.ActiveView; // Get the column object column := GetColumn(grid, view, columnId); // Get the row object row := view.ViewData.Rows(rowIndex); // Get the cell text Result := view.DataController.DisplayTexts(row.RecordIndex, column.Index); 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, s; p = Sys["Process"]("Project1"); Grid = p["VCLObject"]("Form1")["VCLObject"]("cxGrid1"); // Obtain the cell value s = GetCellValue(Grid, null, 4, 2); // Post the value to the log Log["Message"](s); } // Obtain cell value function GetCellValue(grid, view, rowIndex, columnId) { var column, row; // Obtain the view if (view == null) view = grid["ActiveView"]; // Get the column object column = GetColumn(grid, view, columnId); // Get the row object row = view["ViewData"]["Rows"](rowIndex); // Get the cell text return view["DataController"]["DisplayTexts"](row["RecordIndex"], column["Index"]); } // 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); } }

One more way to obtain the cell text is to use the following property of the view object:

ViewObj.ViewData.Rows(rowIndex).DisplayTexts(columnIndex)

The following sample demonstrates how you can use this property:

Working With Developer Express Quantum Grid - Getting Cell Values

Products

Additional Links