XtraReportBase.GetCurrentRow() Method

Returns the currently processed data row from the report’s DataSource.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v19.1.dll

NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Core

Declaration

C#

public object GetCurrentRow()

VB.NET

Public Function GetCurrentRow As Object

Returns

Type	Description
Object	A data object from the report’s XtraReportBase.DataSource.

Remarks

Call the GetCurrentRow method in the XRControl.BeforePrint event handler to obtain the current row from your business object (for instance, if you bind a report to the object data source, EF data source or XPO data source). You can then use the obtained row to get a value of the object’s method or field that implements custom logic.

Use the GetCurrentColumnValue method instead to get the current value of a data source’s property (for instance, when you bind a report to the SQL data source).

Example

This example demonstrates how to use the GetCurrentRow method to filter the XRPivotGrid data.

The example assumes that you have the MyOrder business object with the OrderDate, CategoryName, Country, SalesPerson and ExtendedPrice members. The report is bound to this object and is grouped against the Country member. The Group Header band contains the label that displays the current country and the XRPivotGrid control as shown below.

When the report is previewed, the XRPivotGrid displays the entire data set in each group (that is, displays information for all countries regardless of the group settings).

This example shows how use the GetCurrentRow method to obtain the current group value (the current country) and filter the XRPivotGrid by this country.

C#

using DevExpress.Data.Filtering;
// ...
private void xrPivotGrid1_BeforePrint1(object sender, System.Drawing.Printing.PrintEventArgs e) {
    // Retrieve the current row and get the "Country" member's value.
    var rowOrder = (MyApplication.MyOrder)GetCurrentRow();
    string country = rowOrder.Country;

    // Filter the Pivot Grid by the retrieved value.
    xrPivotGrid1.Prefilter.Criteria = new BinaryOperator(
        new OperandProperty("Country"),
        new ConstantValue(country),
        BinaryOperatorType.Equal);
}

VB.NET

Imports DevExpress.Data.Filtering
' ...
Private Sub XrPivotGrid1_BeforePrint(ByVal sender As Object, ByVal e As System.Drawing.Printing.PrintEventArgs)
    ' Retrieve the current row and get the "Country" member's value.
      Dim rowOrder = CType(GetCurrentRow(), MyApplication.MyOrder)
      Dim country As String = rowOrder.Country

    ' Filter the Pivot Grid by the retrieved value.
      xrPivotGrid1.Prefilter.Criteria = New BinaryOperator(
      New OperandProperty("Country"), 
      New ConstantValue(country), 
      BinaryOperatorType.Equal)
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetCurrentRow() 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_how-to-implement-editing-in-the-preview-form-e26/CS/XtraReport1.cs#L25

private void xrLabel4_BeforePrint(object sender, PrintEventArgs e) {
    ((XRLabel)sender).Tag = this.DetailReport.GetCurrentRow();
}

Reporting_sqldatasource-how-to-use-expressionevaluator-to-programmatically-filter-report-t328522/CS/XtraReport2.cs#L25

private bool IsFit() {
    ResultRow rr = this.GetCurrentRow() as ResultRow;

Reporting_how-to-create-a-hierarchical-report-t456484/CS/TreeViewReport/ChildReport.cs#L15

XRSubreport subReport = sender as XRSubreport;
ParentNode parentNode = this.GetCurrentRow() as ParentNode;
ChildReport childReport = new ChildReport();

VB.NET

Reporting_how-to-implement-editing-in-the-preview-form-e26/VB/XtraReport1.vb#L27

Private Sub xrLabel4_BeforePrint(ByVal sender As Object, ByVal e As PrintEventArgs) Handles xrLabel6.BeforePrint, xrLabel5.BeforePrint, xrLabel4.BeforePrint
    CType(sender, XRLabel).Tag = Me.DetailReport.GetCurrentRow()
End Sub

Reporting_sqldatasource-how-to-use-expressionevaluator-to-programmatically-filter-report-t328522/VB/XtraReport2.vb#L27

Private Function IsFit() As Boolean
    Dim rr As ResultRow = TryCast(Me.GetCurrentRow(), ResultRow)

Reporting_how-to-create-a-hierarchical-report-t456484/VB/TreeViewReport/ChildReport.vb#L17

Dim subReport As XRSubreport = TryCast(sender, XRSubreport)
Dim parentNode As ParentNode = TryCast(Me.GetCurrentRow(), ParentNode)
Dim childReport As New ChildReport()