| 1 Test

Working With Developer Express QuantumGrid - Activating In-place Editors

April 18, 2007

The QuantumGrid control lets users change data directly within grid cells. This article explains how you can activate an in-place editor from scripts.

Before activating the cell’s in-place editor, you need to locate the desired cell within the grid and select it. After the desired cell is chosen, you can activate an in-place editor of the cell by simulating keyboard shortcuts over the grid window, or by calling internal methods and properties of the TcxGrid control (TcxGrid is a class name of the QuamtumGrid component).

To perform these actions, 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.

Simulating Keyboard Shortcuts

The focused cell’s in-place editor can be activated upon pressing the F2 key. You can simulate this key press using the Keys action applied to the TcxGrid object. Below is a sample that demonstrates how you can do this.

The sample code contains the following routines:

Main - The “main” routine of the sample. It obtains the scripting object corresponding to the tested TcxGrid control and then calls the ActivateCellInplaceEditor routine to activate the in-place editor of a cell.
ActivateCellInplaceEditor - This routine calls the SelectGridCell routine to choose the desired cell and then simulates the F2 keystroke over the grid window.

The ActivateCellInplaceEditor routine uses the following parameters:
- grid - The scripting object that corresponds to the tested grid.
- view - The view object that is used to display 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.
SelectGridCell - Chooses the cell specified by its row and column indexes.
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") ' Activate in-place editor Call ActivateCellInplaceEditor(Grid, Nothing, 4, 3) End Sub ' Activate in-place editor Sub ActivateCellInplaceEditor(grid, view, rowIndex, columnId) ' Select the cell Call SelectGridCell(grid, view, rowIndex, columnId) ' Simulate keystroke Call grid.Keys("[F2]") 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"); // Activate in-place editor ActivateCellInplaceEditor(Grid, null, 4, 3); } // Activate in-place editor function ActivateCellInplaceEditor(grid, view, rowIndex, columnId) { // Select the cell SelectGridCell(grid, view, rowIndex, columnId); // Simulate the keystroke grid.Keys("[F2]"); } // 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; procedure ActivateCellInplaceEditor(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'); // Activate in-place editor ActivateCellInplaceEditor(Grid, nil, 4, 3); end; // Activate in-place editor procedure ActivateCellInplaceEditor(grid, view, rowIndex, columnId); begin // Select the cell SelectGridCell(grid, view, rowIndex, columnId); // Simulate the keystroke grid.Keys('[F2]'); 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, r; p = Sys["Process"]("Project1"); Grid = p["VCLObject"]("Form1")["VCLObject"]("cxGrid1"); // Activate in-place editor ActivateCellInplaceEditor(Grid, null, 4, 3); } // Activate in-place editor function ActivateCellInplaceEditor(grid, view, rowIndex, columnId) { // Select the cell SelectGridCell(grid, view, rowIndex, columnId); // Simulate the keystroke grid["Keys"]("[F2]"); } // 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); } }

Using TcxGrid Internal Methods

You can also activate an in-place editor by calling the Controller.EditingController.ShowEdit method of the view object that is used by the TcxGrid object. The ShowEdit method can use one or several parameters that specify various options. For more information on these parameters, please see the QuantumGrid documentation. In our example, we will only pass one parameter to this method - 0 (VBScript), null (JScript, C++Script, C#Script) or nil (DelphiScript). The following code demonstrates how to activate an in-place editor by calling the ShowEdit method.

' [TestComplete VBScript] Sub Main Set p = Sys.Process("Project1") Set Grid = p.VCLObject("Form1").VCLObject("cxGrid1") 'Set Grid = GetGrid1 ' Activate in-place editor Call ActivateCellInplaceEditor(Grid, Nothing, 4, 3) End Sub ' Activate in-place editor Sub ActivateCellInplaceEditor(grid, view, rowIndex, columnId) ' Obtain the view object If view Is Nothing Then Set view = grid.ActiveView End If ' Select the cell Call SelectGridCell(grid, view, rowIndex, columnId) ' Activate in-place editor Call view.Controller.EditingController.ShowEdit(0) 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"); // Set Grid = GetGrid1 // Activate in-place editor ActivateCellInplaceEditor(Grid, null, 4, 3); } // Activate in-place editor function ActivateCellInplaceEditor(grid, view, rowIndex, columnId) { // Select the view object if (view == null) view = grid.ActiveView; // Select the cell SelectGridCell(grid, view, rowIndex, columnId); // Activate in-place editor view.Controller.EditingController.ShowEdit(null); } // 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; procedure ActivateCellInplaceEditor(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'); // Activate in-place editor ActivateCellInplaceEditor(Grid, nil, 4, 3); end; // Activate in-place editor procedure ActivateCellInplaceEditor(grid, view, rowIndex, columnId); begin // Obtain the view object if view = nil then view := grid.ActiveView; // Select the cell SelectGridCell(grid, view, rowIndex, columnId); // Activate in-place editor view.Controller.EditingController.ShowEdit(nil); 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, r; p = Sys["Process"]("Project1"); Grid = p["VCLObject"]("Form1")["VCLObject"]("cxGrid1"); // Activate in-place editor ActivateCellInplaceEditor(Grid, null, 4, 3); } // Activate in-place editor function ActivateCellInplaceEditor(grid, view, rowIndex, columnId) { // Obtain the view object if (view == null) view = grid.ActiveView; // Select the cell SelectGridCell(grid, view, rowIndex, columnId); // Activate the in-place editor view.Controller.EditingController.ShowEdit(null); } // 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 - Activating In-place Editors

Simulating Keyboard Shortcuts

Using TcxGrid Internal Methods

Products

Additional Links