ColumnView.GetDataRow(Int32) Method

Returns a DataRow in the bound DataTable that contains data for the specified grid row.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v23.2.dll

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

Declaration

C#

public virtual DataRow GetDataRow(
    int rowHandle
)

VB.NET

Public Overridable Function GetDataRow(
    rowHandle As Integer
) As DataRow

Parameters

Name	Type	Description
rowHandle	Int32	An integer value that specifies a grid row’s handle. Note that grid rows and their handles are not equal to data rows and their indexes in the bound data source.

Returns

Type	Description
DataRow	A DataRow object representing the specified row.

Remarks

Use the following methods to get an object that contains data for a specific node:

• GetRow(Int32) — Returns an Object in the bound data source that contains data for the specified grid row.

  To get the focused grid row’s data row, use the GetFocusedRow() method.

• GetDataRow(Int32) — Returns a DataRow in the bound DataTable that contains data for the specified grid row.

  To get the focused grid row’s DataRow, use the GetFocusedDataRow() method.

  Note

  If the bound data source is a custom collection, these methods return null (Nothing in VB).

To specify the row in the method’s parameter, use the row’s handle.

For a group row, these methods return the first grid row’s underlying data row.

Note

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

Example

This example demonstrates how to obtain selected rows, and then change values of their “Discounted” column cells.

If Grid data is sorted or filtered, changes made to one Grid row can make other rows change their order and, as a result, their row handles. For this reason, you cannot access selected rows by their handles and process these rows right away. Instead, pass row handles retrieved by the ColumnView.GetSelectedRows method to the ColumnView.GetDataRow method. This allows you to access underlying data source objects (in this example, DataRows), save them to an array, and safely change their values afterwards.

Each row modification forces the Grid View to update itself. Enclose your code with the BaseView.BeginUpdate and BaseView.EndUpdate method calls to avoid excessive updates. Refer to the Batch Modifications Overview document for details.

C#

ArrayList rows = new ArrayList();

// Add the selected rows to the list.
Int32[] selectedRowHandles = gridView1.GetSelectedRows();
for (int i = 0; i < selectedRowHandles.Length; i++) {
    int selectedRowHandle = selectedRowHandles[i];
    if (selectedRowHandle >= 0)
        rows.Add(gridView1.GetDataRow(selectedRowHandle));
}
try {
    gridView1.BeginUpdate();
    for (int i = 0; i < rows.Count; i++) {
        DataRow row = rows[i] as DataRow;
        // Change the field value.
        row["Discontinued"] = true;
    }
}
finally {
    gridView1.EndUpdate();
}

VB.NET

Dim Rows As New ArrayList()

' Add the selected rows to the list.
Dim selectedRowHandles As Int32() = GridView1.GetSelectedRows()
Dim I As Integer
For I = 0 To selectedRowHandles.Length - 1
    Dim selectedRowHandle As Int32 = selectedRowHandles(I)
    If (selectedRowHandle >= 0) Then
        Rows.Add(GridView1.GetDataRow(selectedRowHandle))
    End If
Next
Try
    GridView1.BeginUpdate()
    For I = 0 To Rows.Count - 1
        Dim Row As DataRow = CType(Rows(I), DataRow)
        ' Change the field value.
        Row("Discontinued") = True
    Next
Finally
    GridView1.EndUpdate()
End Try

Run Demo: Obtain Selected Rows

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetDataRow(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-move-focused-row-up-down/CS/Form1.cs#L210

DataRow row1 = view.GetDataRow(index);
DataRow row2 = view.GetDataRow(index - 1);

winforms-reporting-create-grid-based-report/CS/Reporting_how-to-convert-an-xtragrid-to-an-xtrareport-at-runtime-e108/Form1.cs#L26

if (!gridView1.IsGroupRow(rowHandle)) {
    gridRow = gridView1.GetDataRow(rowHandle);
    ds.Tables[0].Rows.Add(gridRow.ItemArray);

VB.NET

winforms-grid-move-focused-row-up-down/VB/Form1.vb#L207

If index <= 0 Then Return
Dim row1 As DataRow = view.GetDataRow(index)
Dim row2 As DataRow = view.GetDataRow(index - 1)