WebDocumentViewerOperationLogger.BuildStarting(String, XtraReport, ReportBuildProperties) Method

Called before starting to asynchronously build a report document.

Namespace: DevExpress.XtraReports.Web.WebDocumentViewer

Assembly: DevExpress.XtraReports.v24.2.Web.dll

NuGet Package: DevExpress.Web.Reporting.Common

Declaration

C#

public virtual Action BuildStarting(
    string reportId,
    XtraReport report,
    ReportBuildProperties buildProperties
)

VB.NET

Public Overridable Function BuildStarting(
    reportId As String,
    report As XtraReport,
    buildProperties As ReportBuildProperties
) As Action

Parameters

Name	Type	Description
reportId	String	A string that identifies the report in the Web Document Viewer report storage.
report	XtraReport	A report instance.
buildProperties	ReportBuildProperties	Contains information about the drill-down state and report parameters.

Returns

Type	Description
Action	A Action delegate.

Remarks

The BuildStarting method returns an action that is executed in a separate thread when asynchronous report document construction begins. You can use the BuildStarting method to access HttpContext values in the XRControl.BeforePrint report event handler.

The following example code shows how to use the BuildStarting method to enable synchronous report document creation.

C#

using DevExpress.XtraReports.UI;
using DevExpress.XtraReports.Web.WebDocumentViewer;
using System;
// ...

public class ViewerOperationLogger : WebDocumentViewerOperationLogger {
    public override Action BuildStarting(string reportId, XtraReport report, ReportBuildProperties buildProperties) {
        report.CreateDocument();
        return null;
    }
}

VB.NET

Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraReports.Web.WebDocumentViewer
Imports System
' ...

Public Class ViewerOperationLogger
    Inherits WebDocumentViewerOperationLogger
    Public Overrides Function BuildStarting(reportId As String, report As XtraReport, buildProperties As ReportBuildProperties) As Action
        report.CreateDocument()
        Return Nothing
    End Function
End Class

For more information, review the following help topics:

• Document Viewer Lifecycle
• Web Document Viewer Cache Management