ColumnView.GetRowHandle(Int32) Method

Returns the handle of the row which represents the specified record in the data source.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v24.1.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#

public int GetRowHandle(
    int dataSourceIndex
)

VB.NET

Public Function GetRowHandle(
    dataSourceIndex As Integer
) As Integer

Parameters

Name	Type	Description
dataSourceIndex	Int32	The zero-based index of a record in the data source.

Returns

Type	Description
Int32	An integer value which represents the handle of the row which corresponds to the specified record in the data source.

Remarks

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 GetRowHandle member must not be invoked for these Views. The GetRowHandle member can only be used with Views that display real data within the Grid Control. Use the following methods to access these Views with which an end user interacts at runtime.

• 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 GetRowHandle(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-grid-display-custom-rows/CS/CustomRowInGrid/CustomRowInGrid/BlankItem.cs#L51

int index = Wrapper.IndexOf(ItemObject);
int nullHandle = View.GetRowHandle(View.GetRowHandle(index));
return nullHandle;

winforms-grid-multiple-row-selection-web-style-checkboxes/CS/E1271/CheckMarkSelection.cs#L201

if(e.IsGetData)
    e.Value = IsRowSelected(View.GetRowHandle(e.ListSourceRowIndex));
else

winforms-grid-auto-expand-new-master-row/CS/Q205071/Form1.cs#L47

    view.MasterRowExpanded += new CustomMasterRowEventHandler(OnGridViewMasterRowExpanded);
    view.SetMasterRowExpanded(view.GetRowHandle(((IList)view.DataSource).Count - 1), true);
}

winforms-grid-add-radio-group-column/CS/Helper/GridRadioGroupColumnHelper.cs#L55

{
    int rowHandle = _GridView.GetRowHandle(dataSourceRowIndex);
    _GridView.SetRowCellValue(rowHandle, RadioGroupColumn, value);

how-to-show-chart-legend-with-markers-in-separate-control-e2366/CS/Form1.cs#L63

{
    gridView1.FocusedRowHandle = gridView1.GetRowHandle(chart.Series.IndexOf(((Series)e.Object)));

VB.NET

winforms-grid-display-custom-rows/VB/CustomRowInGrid/SummaryItem.vb#L45

Dim index As Integer = Wrapper.IndexOf(ItemObject)
Dim nullHandle As Integer = View.GetRowHandle(View.GetRowHandle(index))
Return nullHandle

winforms-grid-multiple-row-selection-web-style-checkboxes/VB/E1271/CheckMarkSelection.vb#L234

If e.IsGetData Then
    e.Value = IsRowSelected(View.GetRowHandle(e.ListSourceRowIndex))
Else

winforms-grid-auto-expand-new-master-row/VB/Q205071/Form1.vb#L49

    AddHandler view.MasterRowExpanded, New CustomMasterRowEventHandler(AddressOf OnGridViewMasterRowExpanded)
    view.SetMasterRowExpanded(view.GetRowHandle(CType(view.DataSource, IList).Count - 1), True)
End Sub

winforms-grid-add-radio-group-column/VB/Helper/GridRadioGroupColumnHelper.vb#L58

Private Sub SetRowChecked(ByVal dataSourceRowIndex As Integer, ByVal value As Boolean)
    Dim rowHandle As Integer = _GridView.GetRowHandle(dataSourceRowIndex)
    _GridView.SetRowCellValue(rowHandle, RadioGroupColumn, value)

how-to-show-chart-legend-with-markers-in-separate-control-e2366/VB/Form1.vb#L64

If e.HitInfo.InSeries Then
    gridView1.FocusedRowHandle = gridView1.GetRowHandle(chart.Series.IndexOf((CType(e.Object, Series))))