GetValueEventArgs.Value Property

Gets or sets a value of a calculated field.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.2.dll

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

Declaration

C#

public object Value { get; set; }

VB.NET

Public Property Value As Object

Property Value

Type	Description
Object	A Object representing a field’s value.

Remarks

Use the Value property in the CalculatedField.GetValue event handler to obtain the current value of a calculated field, and to assign a custom value when it is calculated.

Example

The report created in this example is bound to the “Orders” table of the sample Northwind database (the nwind.mdb file located in the directory where you installed DevExpress demos).

To sort records by days of the week at runtime, do the following.

1. Create a calculated field with the CalculatedField.FieldType property set to String. Add a GroupHeader band, and add a grouping criteria (with the GroupField.FieldName property set to the created calculated field) to its GroupHeaderBand.GroupFields collection.
2. Then, drop the calculated field from the Field List onto the GroupHeader1 band for the XRLabel control (named hdrLabel) bound to the field to be automatically created.
3. Handle the calculated field’s CalculatedField.GetValue and the hdrLabel‘s XRControl.BeforePrint event handlers in the following way.

C#

using System;
using System.Data;
using System.Windows.Forms;
using DevExpress.XtraReports.UI;
// ...

private void calculatedField1_GetValue(object sender, GetValueEventArgs e) {
    object columnValue = e.GetColumnValue("OrderDate");
    e.Value = (int)((DateTime)columnValue).DayOfWeek;
}

private void hdrLabel_BeforePrint(object sender, System.Drawing.Printing.PrintEventArgs e) {
    hdrLabel.Text = ((DayOfWeek)this.GetCurrentColumnValue(this.calculatedField1.Name)).ToString();
}

VB.NET

Imports System
Imports System.Data
Imports System.Windows.Forms
Imports DevExpress.XtraReports.UI
' ...

Private Sub calculatedField1_GetValue(ByVal sender As Object, _ 
ByVal e As GetValueEventArgs) Handles calculatedField1.GetValue
    Dim columnValue As Object = e.GetColumnValue("OrderDate")
    e.Value = CInt(Fix((CDate(columnValue)).DayOfWeek))
End Sub

Private Sub hdrLabel_BeforePrint(ByVal sender As Object, _ 
ByVal e As System.Drawing.Printing.PrintEventArgs) Handles hdrLabel.BeforePrint
    hdrLabel.Text = (CType(Me.GetCurrentColumnValue(Me.calculatedField1.Name), _ 
    DayOfWeek)).ToString()
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Value property.

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-get-access-to-the-fields-in-the-parent-table-e1632/CS/GetValue/XtraReport1.cs#L20

    DataRowView view = e.Row as DataRowView;
    e.Value = GetCurrentColumnValue("CategoryName") + " " + view.Row["UnitPrice"];
}

Reporting_how-to-get-a-calculated-field-value-in-the-other-calculated-fields-getresult-event-t328515/CS/XtraReport1.cs#L28

    e.Value = result;
}

Reporting_how-to-print-a-balanced-number-of-records-in-each-column-in-the-case-of-a-e2029/CS/WindowsApplication1/XtraReport1.cs#L20

    List<DetailItemClass> childRows = ds.Single(x => x.ItemID == currentRow.ParentID).DetailItems;
    e.Value = GetCurrentRowIndex(currentRow,childRows);
}

VB.NET

Reporting_how-to-get-access-to-the-fields-in-the-parent-table-e1632/VB/GetValue/XtraReport1.vb#L18

    Dim view As DataRowView = TryCast(e.Row, DataRowView)
    e.Value = GetCurrentColumnValue("CategoryName") & " " & view.Row("UnitPrice")
End Sub

Reporting_how-to-get-a-calculated-field-value-in-the-other-calculated-fields-getresult-event-t328515/VB/XtraReport1.vb#L30

    e.Value = result
End Sub

Reporting_how-to-print-a-balanced-number-of-records-in-each-column-in-the-case-of-a-e2029/VB/WindowsApplication1/XtraReport1.vb#L22

    Dim childRows As List(Of DetailItemClass) = ds.Single(Function(x) x.ItemID = currentRow.ParentID).DetailItems
    e.Value = GetCurrentRowIndex(currentRow, childRows)
End Sub