The requested page is not available for the requested platform. You are viewing the content for Default platform.

GetValueEventArgs Class

Provides data for the CalculatedField.GetValue event.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v19.1.dll

Declaration

public class GetValueEventArgs :
    EventArgs,
    IDisposable
Public Class GetValueEventArgs
    Inherits EventArgs
    Implements IDisposable

Remarks

The CalculatedField.GetValue event occurs when a calculated field obtains its value, enabling you to return a custom value for this calculated field. The GetValueEventArgs class introduces the GetValueEventArgs.Value property, which accepts the final calculated value for a calculated field, and the GetValueEventArgs.Row and GetValueEventArgs.Report properties, which enable you to obtain any information required to calculate a value for a calculated field.

Note

GetValueEventArgs objects are automatically created, initialized and passed to the CalculatedField.GetValue event handlers.

Examples

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.
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();
}

Inheritance

Object
EventArgs
GetValueEventArgs

Implements

See Also