GridView.GetVisibleRowHandle(Int32) Method

Returns the handle of the row displayed at the specified position.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public override int GetVisibleRowHandle(
    int rowVisibleIndex
)

VB.NET

Public Overrides Function GetVisibleRowHandle(
    rowVisibleIndex As Integer
) As Integer

Parameters

Name	Type	Description
rowVisibleIndex	Int32	An integer value representing a row’s visible index.

Returns

Type	Description
Int32	An integer value representing the desired row’s handle. GridControl.NewItemRowHandle if the specified index corresponds to a new item row or a newly added row which is currently being edited.

Remarks

Refer to the ColumnView.GetVisibleRowHandle topic for more information on obtaining the handles of visible rows.

Note

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

reporting-winforms-convert-grid-to-report/CS/Form1.cs#L24

for (int i = 0; i < gridView1.RowCount; i++) {
    rowHandle = gridView1.GetVisibleRowHandle(i);
    if (!gridView1.IsGroupRow(rowHandle)) {

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

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

how-to-create-a-report-based-on-bandedgridview-at-runtime-t192075/CS/Form1.cs#L24

for (int i = 0; i < gridView1.RowCount; i++) {
    rowHandle = gridView1.GetVisibleRowHandle(i);
    if (!gridView1.IsGroupRow(rowHandle)) {

VB.NET

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

Dim i As Integer = GridView.TopRowIndex
Dim rowHandle As Integer = GridView.GetVisibleRowHandle(i)
Do While GridView.IsRowVisible(rowHandle) = RowVisibleState.Visible

reporting-winforms-convert-grid-to-report/VB/Form1.vb#L27

For i As Integer = 0 To gridView1.RowCount - 1
    rowHandle = gridView1.GetVisibleRowHandle(i)
    If Not gridView1.IsGroupRow(rowHandle) Then

how-to-create-a-report-based-on-bandedgridview-at-runtime-t192075/VB/Form1.vb#L26

For i As Integer = 0 To gridView1.RowCount - 1
    rowHandle = gridView1.GetVisibleRowHandle(i)
    If Not gridView1.IsGroupRow(rowHandle) Then