GridControl.GetRowHandleByListIndex(Int32) Method

Returns the data row’s handle by its index in a data source.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v19.1.dll

Declaration

C#

public int GetRowHandleByListIndex(
    int listIndex
)

VB.NET

Public Function GetRowHandleByListIndex(
    listIndex As Integer
) As Integer

Parameters

Name	Type	Description
listIndex	Int32	An integer value that specifies the index of the corresponding record in a data source.

Returns

Type	Description
Int32	An integer value that specifies the data row’s handle.

Remarks

To learn more, see Identifying Rows and Cards and Obtaining Row Handles.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetRowHandleByListIndex(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#

how-to-preserve-the-dxgrid-for-wpf-view-state-e4222/CS/SaveWpfGridState/RowStateHelper.cs#L89

for (int i = 0; i < gridControl.DataController.ListSourceRowCount; i++) {
    var rowHandle = gridControl.GetRowHandleByListIndex(i);
    if (gridControl.IsMasterRowExpanded(rowHandle))

how-to-control-the-master-row-expansion-from-the-view-model-in-the-master-detail-grid-e3834/CS/WPFDataGridApp15/MVVMHelper/MasterDetailMVVMHelper.cs#L108

{
    int rowHandle = TargetControl.GetRowHandleByListIndex(itemIndex);
    TargetControl.SetMasterRowExpanded(rowHandle, expand);

VB.NET

how-to-preserve-the-dxgrid-for-wpf-view-state-e4222/VB/SaveWpfGridState/RowStateHelper.vb#L89

For i As Integer = 0 To gridControl.DataController.ListSourceRowCount - 1
    Dim rowHandle = gridControl.GetRowHandleByListIndex(i)
    If gridControl.IsMasterRowExpanded(rowHandle) Then

how-to-control-the-master-row-expansion-from-the-view-model-in-the-master-detail-grid-e3834/VB/WPFDataGridApp15/MVVMHelper/MasterDetailMVVMHelper.vb#L122

If itemIndex <> -1 Then
    Dim rowHandle As Integer = TargetControl.GetRowHandleByListIndex(itemIndex)
    TargetControl.SetMasterRowExpanded(rowHandle, expand)