GridView.TopRowIndex Property

Gets or sets the top visible row.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

[Browsable(false)]
public int TopRowIndex { get; set; }

VB.NET

<Browsable(False)>
Public Property TopRowIndex As Integer

Property Value

Type	Description
Int32	An integer value representing the index of the top row visible.

Remarks

To scroll the View via code, you can assign a row’s visible index to the TopRowIndex property. The specified row will become the top visible row, if possible. Note that if the GridOptionsBehavior.SmartVertScrollBar option is disabled, any row within the View can be made top visible. For instance, you can assign the last visible row index to the TopRowIndex property and the row will actually become top visible row within the View. If the option mentioned is enabled, the View will be scrolled to the bottom possible position when the bottom visible row is at the bottom of the View.

Changing this property value raises the GridView.TopRowChanged event.

Please refer to the Rows topic for information on obtaining row visible indexes.

Note

In Embedded detail mode, the TopRowIndex property may return unexpected values when a detail View is open and is scrolled. In this case, the TopRowIndex property may refer to rows within detail Views. To check if the referred row belongs to a detail View, use the ColumnView.GetVisibleRowHandle along with the GridView.IsExternalRow method, as shown below:

C#

int rowHandle = gridView1.GetVisibleRowHandle(gridView1.TopRowIndex);
//Check if the row belongs to a detail View:
if(gridView1.IsExternalRow(rowHandle)) {
    //...
}

Note

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

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-automatically-scroll-the-grid-during-drag-and-drop-e1475/CS/AutoScrollTimer/AutoScrollHelper.cs#L95

if(GoDown)
    view.TopRowIndex++;
if(GoUp)

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

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

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;
}

how-to-determine-what-rows-and-columns-are-actually-visible-in-gridview-e3772/CS/GridViewVisibleCellsHelper.cs#L19

{
    return view.TopRowIndex;
}

how-to-expand-visible-group-rows-when-the-user-searches-using-the-find-panel-e3903/CS/FindPanelExample/MainForm.cs#L37

int rowHandle;
for (int i = GridView.TopRowIndex; GridView.IsRowVisible(rowHandle =
    GridView.GetVisibleRowHandle(i)) == RowVisibleState.Visible; i++)

VB.NET

how-to-automatically-scroll-the-grid-during-drag-and-drop-e1475/VB/AutoScrollTimer/AutoScrollHelper.vb#L104

If GoDown Then
    view.TopRowIndex += 1
End If

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

how-to-determine-what-rows-and-columns-are-actually-visible-in-gridview-e3772/VB/GridViewVisibleCellsHelper.vb#L18

Public  Function GetTopVisibleRow(ByVal view As GridView) As Integer
    Return view.TopRowIndex
End Function

how-to-expand-visible-group-rows-when-the-user-searches-using-the-find-panel-e3903/VB/FindPanelExample/MainForm.vb#L45

Private Sub ExpandVisibleRows()
    Dim i As Integer = GridView.TopRowIndex
    Dim rowHandle As Integer = GridView.GetVisibleRowHandle(i)