XRControl.BeforePrint Event

Occurs before an XRControl object creates its image in a report being generated.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v19.1.dll

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

Declaration

C#

public virtual event PrintEventHandler BeforePrint

VB.NET

Public Overridable Event BeforePrint As PrintEventHandler

Event Data

The BeforePrint event's data class is PrintEventArgs. The following properties provide information specific to this event:

Property	Description
Cancel	Gets or sets a value indicating whether the event should be canceled. Inherited from CancelEventArgs.
PrintAction	Returns PrintToFile in all cases.

Remarks

The BeforePrint event occurs when the report’s CreateDocument method is called (internally form other methods or explicitly).

You can handle this event to change the control’s properties. The event argument’s Cancel property allows you to cancel control rendering.

Note

This event does not have any relation to the actual printing process. To manage print settings, handle the PrintingSystemBase.StartPrint event instead.

The BeforePrint is not raised when you export the document to any available format because the export operation does not recreate the report document.

The BeforePrint event is raised with other events in the following order:

• BeforePrint
• XRControl.AfterPrint
• XRControl.PrintOnPage

See Report Events for more information.

Example

This example demonstrates how to handle a label’s XRControl.BeforePrint event, how to access an XRLabel object in this event handler, and how to customize its appearance based on a specific condition.

Tip

Online Example: How to change a label’s appearance in its BeforePrint event handler

C#

using System;
using System.Drawing;
using DevExpress.XtraReports.UI;
// ...

private void xrLabel_BeforePrint(object sender, System.Drawing.Printing.PrintEventArgs e) {
    // Obtain the current label.
    XRLabel label = (XRLabel)sender;

    // Get the total value.
    double total = Convert.ToDouble(GetCurrentColumnValue("Total"));

    // Customize the label's appearance.
    if (total < 100) {
        label.ForeColor = Color.White;
        label.BackColor = Color.Red;
    }
    else if (total > 1000) {
        label.ForeColor = Color.White;
        label.BackColor = Color.Green;
    }
    else {
        label.ForeColor = Color.Black;
        label.BackColor = Color.Transparent;
    }
}

VB.NET

Imports System
Imports System.Drawing
Imports DevExpress.XtraReports.UI
' ...

Private Sub xrLabel_BeforePrint(ByVal sender As Object, _ 
'ByVal e As System.Drawing.Printing.PrintEventArgs) Handles xrLabel1.BeforePrint, _ 
xrLabel2.BeforePrint, xrLabel3.BeforePrint
    ' Obtain the current label.
    Dim label As XRLabel = CType(sender, XRLabel)

    ' Get the total value.
    Dim total As Double = Convert.ToDouble(GetCurrentColumnValue("Total"))

    ' Customize the label's appearance.
    If total < 100 Then
        label.ForeColor = Color.White
        label.BackColor = Color.Red
    ElseIf total > 1000 Then
        label.ForeColor = Color.White
        label.BackColor = Color.Green
    Else
        label.ForeColor = Color.Black
        label.BackColor = Color.Transparent
    End If
End Sub

Related GitHub Examples

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

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-build-report-pages-progressively-to-be-able-to-access-them-as-soon-as-they-are-e960/CS/Form1.cs#L21

report.BeforePrint += new PrintEventHandler(report_BeforePrint);
report.AfterPrint += new EventHandler(report_AfterPrint);

Reporting_how-to-embed-the-xtratreelist-into-a-report-via-scripts-e1339/CS/XtraReport1.cs#L8

    InitializeComponent();
    this.BeforePrint+=new System.Drawing.Printing.PrintEventHandler(OnBeforePrint);
}

reporting-create-table-at-runtime/CS/XtraReport1.cs#L38

table.BeforePrint += new PrintEventHandler(table_BeforePrint);
table.AdjustSize();

Reporting_how-to-create-a-master-detail-report-type-using-two-report-layouts-at-runtime-e1063/CS/WindowsFormsApplication1/Form1.cs#L27

((XRSubreport)report.FindControl("xrSubreport1", true)).ReportSource = subreport;
((XRSubreport)report.FindControl("xrSubreport1", true)).BeforePrint += new System.Drawing.Printing.PrintEventHandler(Form1_BeforePrint);
report.ShowPreview();

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

};
control.BeforePrint += new System.Drawing.Printing.PrintEventHandler(control_BeforePrint);
e.IsModified = true;

VB.NET

Reporting_how-to-build-report-pages-progressively-to-be-able-to-access-them-as-soon-as-they-are-e960/VB/Form1.vb#L23

AddHandler report.BeforePrint, AddressOf report_BeforePrint
AddHandler report.AfterPrint, AddressOf report_AfterPrint

reporting-create-table-at-runtime/VB/XtraReport1.vb#L39

AddHandler table.BeforePrint, New PrintEventHandler(AddressOf table_BeforePrint)
table.AdjustSize()

Reporting_how-to-create-a-master-detail-report-type-using-two-report-layouts-at-runtime-e1063/VB/WindowsFormsApplication1/Form1.vb#L25

CType(report.FindControl("xrSubreport1", True), XRSubreport).ReportSource = subreport
AddHandler (CType(report.FindControl("xrSubreport1", True), XRSubreport)).BeforePrint, AddressOf Form1_BeforePrint
report.ShowPreview()

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

control.Shape = New ShapeStar() With {.StarPointCount = 5, .Concavity = 30}
AddHandler control.BeforePrint, AddressOf control_BeforePrint
e.IsModified = True

Reporting_how-to-add-a-bar-code-to-a-report-e167/VB/WindowsFormsApplication1/Form1.vb#L719

Dim report As New XtraReport()
AddHandler report.BeforePrint, AddressOf report_BeforePrint