ColumnView.GetFocusedDataSourceRowIndex() Method

Returns the index of the data source record that corresponds to the focused grid row (card).

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public int GetFocusedDataSourceRowIndex()

VB.NET

Public Function GetFocusedDataSourceRowIndex As Integer

Returns

Type	Description
Int32	An integer value representing the zero-based index of the data record that corresponds to the focused grid row (card)

Remarks

To get the source of data displayed in a View, use the BaseView.DataSource property.

See the Accessing Rows in Code. Row Handles section in the Rows topic to learn more.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the GetFocusedDataSourceRowIndex member must not be invoked for these Views. The GetFocusedDataSourceRowIndex 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.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetFocusedDataSourceRowIndex() 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-add-the-capability-to-insert-comments-to-xtragrid-cells-like-in-ms-excel-e2113/CS/WinFormsExample/Form1.cs#L54

void editItem_Click(object sender, EventArgs e) {
    string comment = GetComment(gridView1.FocusedColumn.Name, gridView1.GetFocusedDataSourceRowIndex());
    ShowPopup((DXMenuItem)sender, comment);

how-to-upload-files-to-a-datatable-using-the-gridcontrol-and-be-able-to-open-them-later-e2047/CS/WindowsApplication1/Form1.cs#L83

case 1:
    helper.PostNewFile(gridView1.GetFocusedDataSourceRowIndex());
    gridView1.UpdateCurrentRow();

VB.NET

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

Private Sub editItem_Click(ByVal sender As Object, ByVal e As EventArgs)
    Dim comment As String = GetComment(gridView1.FocusedColumn.Name, gridView1.GetFocusedDataSourceRowIndex())
    ShowPopup(CType(sender, DXMenuItem), comment)

how-to-upload-files-to-a-datatable-using-the-gridcontrol-and-be-able-to-open-them-later-e2047/VB/WindowsApplication1/Form1.vb#L76

Case 1
    helper.PostNewFile(gridView1.GetFocusedDataSourceRowIndex())
    gridView1.UpdateCurrentRow()