GridView.SelectRow(Int32) Method

Selects the specified row.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public override void SelectRow(
    int rowHandle
)

VB.NET

Public Overrides Sub SelectRow(
    rowHandle As Integer
)

Parameters

Name	Type	Description
rowHandle	Int32	An integer value which specifies the handle of the row to select.

Remarks

The SelectRow method selects the specified row and adds it to the current selection. If multiple selection is disabled (the ColumnViewOptionsSelection.MultiSelect option is set to false) the SelectRow method does nothing.

Example

The following code shows how to select rows that contain “Mexico” in the Country column and copy data from these rows.

C#

using DevExpress.XtraGrid;
using DevExpress.XtraGrid.Columns;
using DevExpress.XtraGrid.Views.Base;

ColumnView view = gridControl1.MainView as ColumnView;
GridColumn colCountry = view.Columns["Country"];
GridColumn colCompany = view.Columns["CompanyName"];
if (colCountry == null || colCompany == null) return;

// Enable multiple row selection mode.
view.OptionsSelection.MultiSelect = true;
view.ClearSelection();
int rowHandle = -1;
// Select rows that contain 'Mexico' in the Country column.
while (rowHandle != GridControl.InvalidRowHandle) {
    rowHandle = view.LocateByDisplayText(rowHandle + 1, colCountry, "Mexico");
    view.SelectRow(rowHandle);
}
int[] selectedRowHandles = view.GetSelectedRows();
if (selectedRowHandles.Length > 0) {
    // Move focus to the first selected row.
    view.FocusedRowHandle = selectedRowHandles[0];
    // Copy the selection to the clipboard
    view.CopyToClipboard();
    // Copy the selected company names to a Memo editor.
    memoEdit1.Text = "";
    for (int i = 0; i < selectedRowHandles.Length; i++)
        memoEdit1.Text += view.GetRowCellDisplayText(selectedRowHandles[i], colCompany) + "\r\n";
}

VB.NET

Imports DevExpress.XtraGrid
Imports DevExpress.XtraGrid.Columns
Imports DevExpress.XtraGrid.Views.Base

Dim view As ColumnView = CType(GridControl1.MainView, ColumnView)
Dim colCountry As GridColumn = view.Columns("Country")
Dim colCompany As GridColumn = view.Columns("CompanyName")
If colCountry Is Nothing OrElse colCompany Is Nothing Then Return
'Enable multiple row selection mode.
view.OptionsSelection.MultiSelect = True
view.ClearSelection()
Dim rowHandle As Integer = -1
'Select rows that contain 'Mexico' in the Country column.
While rowHandle <> GridControl.InvalidRowHandle
    rowHandle = view.LocateByDisplayText(rowHandle + 1, colCountry, "Mexico")
    view.SelectRow(rowHandle)
End While

Dim selectedRowHandles As Integer() = view.GetSelectedRows()

If selectedRowHandles.Length > 0 Then
    'Move focus to the first selected row.
    view.FocusedRowHandle = selectedRowHandles(0)
    'Copy the selection to the clipboard
    view.CopyToClipboard()
    'Copy the selected company names to a Memo editor.
    MemoEdit1.Text = ""
    For i As Integer = 0 To selectedRowHandles.Length - 1
        MemoEdit1.Text += view.GetRowCellDisplayText(selectedRowHandles(i), colCompany) & vbCrLf
    Next
End If

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SelectRow(Int32) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-keep-selection-on-click-in-gridcontrol-e3321/CS/KeepSelection/Form1.cs#L45

gridView1.ClearSelection();
gridView1.SelectRow(0);
gridView1.SelectRow(2);

winforms-preserve-grid-state-on-refresh/CS/RefreshHelperClass.cs#L79

    else
        view.SelectRow(GetRowHandleToSelect(rowInfo));
}

how-to-work-with-selection-in-gridcontrol-e2784/CS/WindowsApplication1/Form1.cs#L98

{
    gridView1.SelectRow(5);
}

winforms-gridlookupedit-multiselect/CS/Form1.cs#L91

foreach(int rowHandle in selection) {
    view.SelectRow(rowHandle);
}

how-to-copy-cell-data-in-an-excel-format-biff8-to-the-clipboard-using-xl-export-library-t266171/CS/gridCopyToClipboardExample/CopyToClipboardHelper.cs#L45

    ExportRow(sheet, gridRowHandle);
    view.SelectRow(gridRowHandle);
}

VB.NET

how-to-keep-selection-on-click-in-gridcontrol-e3321/VB/KeepSelection/Form1.vb#L42

gridView1.ClearSelection()
gridView1.SelectRow(0)
gridView1.SelectRow(2)

winforms-preserve-grid-state-on-refresh/VB/RefreshHelperClass.vb#L86

Else
    view.SelectRow(GetRowHandleToSelect(rowInfo))
End If

how-to-work-with-selection-in-gridcontrol-e2784/VB/WindowsApplication1/Form1.vb#L92

Private Sub simpleButton3_Click(ByVal sender As Object, ByVal e As EventArgs) Handles simpleButton3.Click
    gridView1.SelectRow(5)
End Sub

winforms-gridlookupedit-multiselect/VB/Form1.vb#L86

For Each rowHandle As Integer In selection
    view.SelectRow(rowHandle)
Next

how-to-select-all-detail-rows-when-selecting-a-master-row-checkboxrowselection-mode-t130639/VB/MasterDetailSelectionHelper.vb#L25

If _GridView.GetSelectedRows().Length = _GridView.RowCount Then
    TryCast(_GridView.ParentView, GridView).SelectRow(masterRowHandle)
ElseIf _GridView.GetSelectedRows().Length = 0 Then