Skip to main content

WebDocumentViewerOperationLogger.BuildStarting(String, XtraReport, ReportBuildProperties) Method

Called before starting to asynchronously build a report document.

Namespace: DevExpress.XtraReports.Web.WebDocumentViewer

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

NuGet Package: DevExpress.Web.Reporting.Common

Declaration

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

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.

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;
    }
}

For more information, review the following help topics:

See Also