ColumnView.GetDataSourceRowIndex(Int32) Method

Returns the index of the data source record that corresponds to the specified row handle.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

public int GetDataSourceRowIndex(
    int rowHandle
)

VB.NET

Public Function GetDataSourceRowIndex(
    rowHandle As Integer
) As Integer

Parameters

Name	Type	Description
rowHandle	Int32	An integer value representing the row handle.

Returns

Type	Description
Int32	The zero-based index of the data record to which the specified row handle corresponds.

Remarks

See the Accessing Rows in Code. Row Handles section in the Rows topic for information on row handles.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the GetDataSourceRowIndex member must not be invoked for these Views. The GetDataSourceRowIndex member can only be used with real Views that are displayed within the Grid Control. The real Views with which an end-user interacts at runtime can be accessed using the following methods.

• GridControl.MainView - returns the top most View in a grid;
• GridControl.FocusedView - returns the focused View;
• GridControl.DefaultView - returns the currently maximized View;
• the sender parameter of View specific events;
• GridView.GetDetailView - returns a detail clone View for a specific master row.

Example

The following example handles the GridView.CustomDrawRowIndicator event to display data source row indexes in the Row Indicator Panel.

C#

using DevExpress.XtraGrid;
using DevExpress.XtraGrid.Views.Grid;

public partial class Form1 : Form {
    public Form1() {
        InitializeComponent();

        GridControl gridControl1 = new GridControl { Parent = this, Dock = DockStyle.Fill };
        GridView gridView1 = new GridView();
        gridControl1.MainView = gridView1;
        gridView1.OptionsBehavior.Editable = false;

        Random r = new Random();
        List<MyObject> dataSource = new List<MyObject>();
        for (int i = 0; i < 5; i++) 
            dataSource.Add(new MyObject { Id = r.Next(0, 100), Name = string.Format("Name {0}", i) });
        gridControl1.DataSource = dataSource;

        gridView1.Columns["Id"].SortOrder = DevExpress.Data.ColumnSortOrder.Descending;
        gridView1.CustomDrawRowIndicator += gridView_CustomDrawRowIndicator;
        gridView1.IndicatorWidth = 30;
    }

    void gridView_CustomDrawRowIndicator(object sender, RowIndicatorCustomDrawEventArgs e) {
        if (!e.Info.IsRowIndicator) return;
        GridView view = sender as GridView;
        int dataSourceRowIndex = view.GetDataSourceRowIndex(e.RowHandle);
        e.Info.DisplayText = dataSourceRowIndex.ToString();
    }

    public class MyObject {
        public int Id { get; set; }
        public string Name { get; set; }
    }
}

VB.NET

Imports DevExpress.XtraGrid
Imports DevExpress.XtraGrid.Views.Grid

Partial Public Class Form1
    Public Sub New()
        InitializeComponent()

        Dim gridControl1 As GridControl = New GridControl With {
            .Parent = Me,
            .Dock = DockStyle.Fill
        }
        Dim gridView1 As GridView = New GridView()
        gridControl1.MainView = gridView1
        gridView1.OptionsBehavior.Editable = False
        Dim r As Random = New Random()
        Dim dataSource As List(Of MyObject) = New List(Of MyObject)()

        For i As Integer = 0 To 4
            dataSource.Add(New MyObject With {
                .Id = r.[Next](0, 100),
                .Name = String.Format("Name {0}", i)
            })
        Next

        gridControl1.DataSource = dataSource
        gridView1.Columns("Id").SortOrder = DevExpress.Data.ColumnSortOrder.Descending
        AddHandler gridView1.CustomDrawRowIndicator, AddressOf gridView_CustomDrawRowIndicator
        gridView1.IndicatorWidth = 30
    End Sub

    Private Sub gridView_CustomDrawRowIndicator(ByVal sender As Object, ByVal e As RowIndicatorCustomDrawEventArgs)
        If Not e.Info.IsRowIndicator Then Return
        Dim view As GridView = TryCast(sender, GridView)
        Dim dataSourceRowIndex As Integer = view.GetDataSourceRowIndex(e.RowHandle)
        e.Info.DisplayText = dataSourceRowIndex.ToString()
    End Sub
End Class

Public Class MyObject
    Public Property Id As Integer
    Public Property Name As String
End Class

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetDataSourceRowIndex(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-highlight-modified-cells-in-grid-t190692/CS/Form1.cs#L26

void gridView1_CellValueChanged(object sender, DevExpress.XtraGrid.Views.Base.CellValueChangedEventArgs e) {
    if (!CellExists(gridView1.GetDataSourceRowIndex(e.RowHandle), e.Column)){
        modifiedCells.Add(new GridCell(gridView1.GetDataSourceRowIndex(e.RowHandle), e.Column));

how-to-allow-a-user-to-change-the-back-color-of-the-selected-cells-e278/CS/dxSample/Form1.cs#L28

{
    int rowHandle = gridView1.GetDataSourceRowIndex(i);
    Key cell = new Key(rowHandle, gridView1.Columns[j]);

how-to-add-the-capability-to-insert-comments-to-xtragrid-cells-like-in-ms-excel-e2113/CS/WinFormsExample/Form1.cs#L40

if (!e.HitInfo.InRowCell) return;
if (!ContainsComment(e.HitInfo.Column.Name, gridView1.GetDataSourceRowIndex(e.HitInfo.RowHandle))) {
    DXMenuItem insertItem = new DXMenuItem("Insert Comment");

Reporting_embedded-end-user-report-designer-demonstration-e20017/CS/Contacts/Controls/PersonListControl.cs#L58

{
    int handle = gridViewPerson.GetDataSourceRowIndex(gridViewPerson.GetSelectedRows()[0]);
    int oid = (collectionPersons[handle] as Person).Oid;

how-to-merge-cells-horizontally-in-gridview-via-the-customdrawcell-event-e4039/CS/HorizontalMerging/Form1.cs#L45

gridControl1.ForceInitialize();
ViewHandler.MergeCells(gridView1.GetRowCellValue(1, "Name2").ToString(), gridView1.GetDataSourceRowIndex(1), new GridColumn[] { gridView1.Columns[2], gridView1.Columns[3], gridView1.Columns[4] });
ViewHandler.MergeCells(gridView1.GetRowCellValue(3, "Name2").ToString(), gridView1.GetDataSourceRowIndex(3), new GridColumn[] { gridView1.Columns[2], gridView1.Columns[3] });

VB.NET

how-to-highlight-modified-cells-in-grid-t190692/VB/Form1.vb#L28

Private Sub gridView1_CellValueChanged(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.CellValueChangedEventArgs)
    If (Not CellExists(gridView1.GetDataSourceRowIndex(e.RowHandle), e.Column)) Then
        modifiedCells.Add(New GridCell(gridView1.GetDataSourceRowIndex(e.RowHandle), e.Column))

how-to-allow-a-user-to-change-the-back-color-of-the-selected-cells-e278/VB/dxSample/Form1.vb#L25

For j As Integer = 0 To gridView1.Columns.Count - 1
    Dim rowHandle As Integer = gridView1.GetDataSourceRowIndex(i)
    Dim cell As Key = New Key(rowHandle, gridView1.Columns(j))

how-to-add-the-capability-to-insert-comments-to-xtragrid-cells-like-in-ms-excel-e2113/VB/WinFormsExample/Form1.vb#L44

End If
If Not ContainsComment(e.HitInfo.Column.Name, gridView1.GetDataSourceRowIndex(e.HitInfo.RowHandle)) Then
    Dim insertItem As New DXMenuItem("Insert Comment")

Reporting_embedded-end-user-report-designer-demonstration-e20017/VB/Contacts/Controls/PersonListControl.vb#L65

If gridViewPerson.SelectedRowsCount = 1 Then
    Dim handle As Integer = gridViewPerson.GetDataSourceRowIndex(gridViewPerson.GetSelectedRows()(0))
    Dim oid As Integer = (TryCast(collectionPersons(handle), Person)).Oid

how-to-merge-cells-horizontally-in-gridview-via-the-customdrawcell-event-e4039/VB/HorizontalMerging/Form1.vb#L42

gridControl1.ForceInitialize()
ViewHandler.MergeCells(gridView1.GetRowCellValue(1, "Name2").ToString(), gridView1.GetDataSourceRowIndex(1), New GridColumn() { gridView1.Columns(2), gridView1.Columns(3), gridView1.Columns(4) })
ViewHandler.MergeCells(gridView1.GetRowCellValue(3, "Name2").ToString(), gridView1.GetDataSourceRowIndex(3), New GridColumn() { gridView1.Columns(2), gridView1.Columns(3) })