XtraReportBase.GetCurrentColumnValue(String) Method

Gets the current value of the specified column in the report’s DataSource.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.1.dll

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

Declaration

C#

public object GetCurrentColumnValue(
    string columnName
)

VB.NET

Public Function GetCurrentColumnValue(
    columnName As String
) As Object

Parameters

Name	Type	Description
columnName	String	The name of the column to obtain the value from.

Returns

Type	Description
Object	The current value of the specified column in the report’s XtraReportBase.DataSource. If the specified column was not found, this method returns null (Nothing in Visual Basic).

Remarks

Call the GetCurrentColumnValue method in the XRControl.BeforePrint event handler to obtain the current value of the specified data source property (for instance, when you bind a report to the SQL data source).

Note

In a detail report, call the DetailReportBand‘s GetCurrentColumnValue method to retrieve the current value of the specified data source property.

If you do not want to cast the returned object, use the XtraReportBase.GetCurrentColumnValue<T> method, which returns a strongly typed object.

Use the GetCurrentRow method instead if you have a business object and want to get the value of its method or field that implements custom logic (for instance, if you use the object data source, EF data source or XPO data source).

Example

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

The example assumes that your report is bound to the Northwind database’s SalesPerson view. The report data 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 GetCurrentColumnValue 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_BeforePrint(object sender, System.Drawing.Printing.PrintEventArgs e) {
    // Retrieve the "Country" column's current value.
    string country = GetCurrentColumnValue<string>("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 "Country" column's current value.
    Dim country As String = GetCurrentColumnValue(Of String)("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 GetCurrentColumnValue(String) 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-conditionally-hide-detailreportbands-subreports-e271/CS/XtraReport1.cs#L18

{
    int i = Convert.ToInt32(this.GetCurrentColumnValue("CategoryID"));
    if (i % 2 == 1)

Reporting_how-to-implement-a-master-detail-report-by-adjusting-the-filterstring-property-at-e543/CS/MasterDetailFilterString/XtraReport1.cs#L14

private void DetailReport_BeforePrint(object sender, System.Drawing.Printing.PrintEventArgs e) {
    int orderId = Convert.ToInt32(this.GetCurrentColumnValue("OrderID"));
    ((DetailReportBand)sender).FilterString = string.Format("[OrderID] = {0}", orderId);

Reporting_how-to-insert-a-dynamic-hyperlink-in-a-web-report-e484/CS/HyperlinkInReport/XtraReport1.cs#L17

private void xrLabel3_BeforePrint(object sender, System.Drawing.Printing.PrintEventArgs e) {
    ((XRLabel)sender).NavigateUrl = string.Format("MoreInfo.aspx?ID={0}", this.GetCurrentColumnValue("ID"));
}

asp-net-mvc-grid-create-report-based-on-grid-layout/CS/E4755/Controllers/HomeController.cs#L58

void control_BeforePrint(object sender, System.Drawing.Printing.PrintEventArgs e) {
    if (Convert.ToBoolean(((XRShape) sender).Report.GetCurrentColumnValue("Discontinued")) == true)
        ((XRShape) sender).FillColor = Color.Yellow;

VB.NET

Reporting_how-to-conditionally-hide-detailreportbands-subreports-e271/VB/XtraReport1.vb#L16

Private Sub DetailReport_BeforePrint(ByVal sender As Object, ByVal e As System.Drawing.Printing.PrintEventArgs) Handles DetailReport.BeforePrint
    Dim i As Integer = Convert.ToInt32(Me.GetCurrentColumnValue("CategoryID"))
    If i Mod 2 = 1 Then

Reporting_how-to-implement-a-master-detail-report-by-adjusting-the-filterstring-property-at-e543/VB/MasterDetailFilterString/XtraReport1.vb#L16

Private Sub DetailReport_BeforePrint(ByVal sender As Object, ByVal e As System.Drawing.Printing.PrintEventArgs) Handles DetailReport.BeforePrint
    Dim orderId As Integer = Convert.ToInt32(Me.GetCurrentColumnValue("OrderID"))
    DirectCast(sender, DetailReportBand).FilterString = String.Format("[OrderID] = {0}", orderId)

Reporting_how-to-insert-a-dynamic-hyperlink-in-a-web-report-e484/VB/HyperlinkInReport/XtraReport1.vb#L20

Private Sub xrLabel3_BeforePrint(ByVal sender As Object, ByVal e As System.Drawing.Printing.PrintEventArgs) Handles xrLabel3.BeforePrint
    CType(sender, XRLabel).NavigateUrl = String.Format("MoreInfo.aspx?ID={0}", Me.GetCurrentColumnValue("ID"))
End Sub

asp-net-mvc-grid-create-report-based-on-grid-layout/VB/E4755/Controllers/HomeController.vb#L57

Private Sub control_BeforePrint(ByVal sender As Object, ByVal e As System.Drawing.Printing.PrintEventArgs)
    If Convert.ToBoolean((CType(sender, XRShape)).Report.GetCurrentColumnValue("Discontinued")) = True Then
        CType(sender, XRShape).FillColor = Color.Yellow