GridView.GetVisibleIndex(Int32) Method

Gets the row’s visible index.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

public override int GetVisibleIndex(
    int rowHandle
)

VB.NET

Public Overrides Function GetVisibleIndex(
    rowHandle As Integer
) As Integer

Parameters

Name	Type	Description
rowHandle	Int32	An integer value specifying the handle of the inspected row.

Returns

Type	Description
Int32	An integer value representing the row’s visible index.

Remarks

Visible indexes define the order in which data and group rows are displayed within a View. The GetVisibleIndex method returns -1 in the cases listed below:

• the inspected row is hidden within a collapsed group;
• the inspected row is a new item row which is displayed at the top of a View (the GridOptionsView.NewItemRowPosition property is set to the NewItemRowPosition.Top value);
• the inspected row is an auto filter row.

If no row with the specified handle is found, the GetVisibleIndex method returns GridControl.InvalidRowHandle.

Note

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

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

public void SaveVisibleIndex(){
    visibleRowIndex = view.GetVisibleIndex(view.FocusedRowHandle) - view.TopRowIndex;
}

how-to-prevent-the-group-row-from-being-selected-e460/CS/Form1.cs#L39

{
    int prevRow = view.GetVisibleIndex(e.PrevFocusedRowHandle);
    int currRow = view.GetVisibleIndex(e.FocusedRowHandle);

how-to-preserve-the-xtragrid-view-state-in-multi-level-master-detail-e1466/CS/RefreshHelperClass.cs#L211

public void SaveVisibleIndex(GridView view) {
    visibleRowIndex = view.GetVisibleIndex(view.FocusedRowHandle) - view.TopRowIndex;
}

VB.NET

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

Public Sub SaveVisibleIndex()
    visibleRowIndex = view.GetVisibleIndex(view.FocusedRowHandle) - view.TopRowIndex
End Sub

how-to-preserve-the-xtragrid-view-state-in-multi-level-master-detail-e1466/VB/RefreshHelperClass.vb#L232

Public Sub SaveVisibleIndex(ByVal view As GridView)
    visibleRowIndex = view.GetVisibleIndex(view.FocusedRowHandle) - view.TopRowIndex
End Sub