ReportWizardCustomizationService.CustomizeReportOnFinishAsync(XtraReport) Method

Allows you to customize the report before loading it into the End-User Designer for further editing, asynchronously.

Namespace: DevExpress.XtraReports.Web.ReportDesigner.Services

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

NuGet Package: DevExpress.Web.Reporting.Common

Declaration

C#

public virtual Task CustomizeReportOnFinishAsync(
    XtraReport report
)

VB.NET

Public Overridable Function CustomizeReportOnFinishAsync(
    report As XtraReport
) As Task

Parameters

Name	Type	Description
report	XtraReport	A report created using wizard steps.

Returns

Type	Description
Task	A Task that completes when the method is finished.

Remarks

The CustomizeReportOnFinishAsync method is called in asynchronous mode.

The CustomizeReportOnFinishAsync method is called when a user has completed all the steps within the Report Wizard, and after the TryCreateCustomReportAsync method.

The CustomizeReportOnFinishAsync method is also called when a user runs the New command in the Report Designer.

The following code adds a report header to the report created using the wizard:

C#

  public override Task CustomizeReportOnFinishAsync(XtraReport report) {
      if (report.Bands.GetBandByType(typeof(ReportHeaderBand)) == null)
          report.Bands.Add(new ReportHeaderBand() { Controls = { new XRLabel() { Text = "My Report" } } });
      return Task.CompletedTask;
  } 

For more information on asynchronous mode, review the following help topics:

ASP.NET Core	ASP.NET MVC
ReportingConfigurationBuilder.UseAsyncEngine	DefaultReportDesignerContainer.UseAsyncEngine