| 1 Test

Obtaining Selected Rows in Developer Express XtraGrid

May 28, 2007

In my previous article, I explained how to select multiple rows in Developer Express XtraGrid controls. You may then need to process the selected records in a certain way. To work with the selected records, you can use the following properties and methods of the grid’s view that contains the selection:

viewObj.GetSelectedRows() - Returns an array holding indexes of rows (cards) currently selected in the view. Note that the returned array is a .NET object, so you cannot access its elements using simple indexing. You should use the object’s internal properties or methods instead.
viewObj.SelectedRowsCount - Returns the number of currently selected rows (cards).

Note: In order for TestComplete to be able to access the mentioned methods, the .NET Open Application Support plug-in is installed and enabled.

Below is an example that demonstrates how you can work with selections in the XtraGrid control. This example works with the GridTutorials sample application shipped with the Developer Express XtraGrid Suite. The script contains the following routines:

Main - The “main” routine of the example. It obtains the scripting object corresponding to the XtraGrid control, selects a range or rows, calls GetSelectedRowIndexes to get indexes of selected rows, and then post texts in the selected rows’s “Product” column to the test log.
SelectRange2 - Selects the specified range of rows in the grid. For more information on this routine, see Selecting Multiple Rows in Developer Express XtraGrid.
GetSelectedRowIndexes - Returns an array containing zero-based indexes of rows (cards) selected in the grid. The routine has two parameters:
- Grid - The tested XtraGrid control.
- View - The grid’s view in which the selected rows (cards) reside. If the null value (Nothing in VBScript) is passed in this parameter, it means that the selection belongs to the main (top-level) view.
GetCellText - Returns the text displayed in the specified cell. This routine was defined in Getting Cell Values in Developer Express XtraGrid.
GetColumn - A helper function that returns the column object specified by its caption or zero-based index.

' [TestComplete VBScript] Sub Main Dim p, frmMain, Grid, RowIndexes, i ' Obtain the application process and its main form Set p = Sys.Process("GridTutorials") Set frmMain = p.WinFormsObject("frmMain") frmMain.Activate ' Select the "Multi Select" demo frmMain.WinFormsObject("gcNavigations").WinFormsObject("listBoxControl1").SelectedItem = "Multi Select" ' Obtain the grid object Set Grid = frmMain.WinFormsObject("pcMain").WinFormsObject("gcContainer").WinFormsObject("Form1").WinFormsObject("gridControl1") ' Select a range of rows Call SelectRange2 (Grid, Nothing, 4, 27) ' Iterate through the selected rows RowIndexes = GetSelectedRowIndexes (Grid, Nothing) For i=0 To UBound(RowIndexes) Log.Message GetCellText (Grid, Nothing, RowIndexes(i), "Product") Next End Sub ' Selects the specified range of rows Sub SelectRange2 (Grid, View, StartRowIndex, EndRowIndex) ' Get the grid view object, if it is not specified If View Is Nothing Then Set View = Grid.MainView End If ' Clear the previous selection Call View.ClearSelection ' Select the specified range of rows Call View.SelectRange (StartRowIndex, EndRowIndex) End Sub ' Returns an array of selected rows' indexes Function GetSelectedRowIndexes (Grid, View) Dim SelectedRows, arr, i ' Get the grid view object, if it is not specified If View Is Nothing Then Set View = Grid.MainView End If ' Get an array of selected rows' handles Set SelectedRows = View.GetSelectedRows() ' Convert a .NET array to a Variant array arr = BuiltIn.CreateVariantArray (0, View.SelectedRowsCount-1) For i=0 To View.SelectedRowsCount-1 arr(i) = SelectedRows.Get(i) Next GetSelectedRowIndexes = arr End Function ' Returns the text displayed in the specified cell Function GetCellText (Grid, View, RowHandle, ColumnId) Dim Column ' Get the grid view object, if it is not specified If View Is Nothing Then Set View = Grid.MainView End If ' Get the column object Set Column = GetColumn (Grid, View, ColumnId) ' Get the cell's display text GetCellText = View.GetRowCellDisplayText(RowHandle, Column).OleValue End Function ' Returns the column object by its caption or index Function GetColumn (Grid, View, ColumnId) Dim Columns, Col, i ' Get the grid view object, if no view is specified If View Is Nothing Then Set View = Grid.MainView End If ' Search for the specified column Set Columns = View.VisibleColumns If BuiltIn.VarType (ColumnId) = varOleStr Then ' The column is specified by its caption For i=0 To Columns.Count-1 Set Col = Columns.Item(i) If Col.Caption.OleValue = ColumnId Then Set GetColumn = Col ' The column is found Exit Function End If Next Set GetColumn = Nothing ' The column is not found Else ' The column is specified by its visible index Set GetColumn = Columns.Item(ColumnId) End If End Function

Obtaining Selected Rows in Developer Express XtraGrid

Products

Additional Links