StartupExtensions.RemoveDefaultReportingControllers(IMvcBuilder) Method

Removes the default reporting controllers from an application.

Namespace: DevExpress.AspNetCore.Reporting

Assembly: DevExpress.AspNetCore.Reporting.v21.1.dll

Declaration

public static IMvcBuilder RemoveDefaultReportingControllers(
    this IMvcBuilder builder
)

Parameters

Name Type Description
builder IMvcBuilder

The IMvcBuilder instance this method extends.

Returns

Type Description
IMvcBuilder

A IMvcBuilder that can be used to further configure the MVC services.

Remarks

When you add the DevExpress.AspNetCore.Reporting assembly to your application, the default MVC reporting controllers are registered automatically.

If you want to use your custom controllers to process requests, call the RemoveDefaultReportingControllers method to unregister the default controllers.

using DevExpress.AspNetCore;
using DevExpress.AspNetCore.Reporting;
//... 

public class Startup {
//... 
    public void ConfigureServices(IServiceCollection services) {
        services.AddDevExpressControls();
        services.AddMvc().RemoveDefaultReportingControllers(); 
    }
//...    
}

To implement custom MVC reporting controllers:

You can customize controllers and change routes, but it is not necessary in most situations. The following table lists controllers that process requests from reporting components, and their default routes:

Component Controller Predefined Route
Report Designer ReportDesignerController DXXRD
Document Viewer WebDocumentViewerController DXXRDV
Query Builder QueryBuilderController DXXQB

An application with End-User Report Designer requires all three controllers for proper operation.

To implement a custom controller, create a descendant of the class listed above and use the HandlerUri property to specify the route:

Component Handler Uri
Report Designer ReportDesignerHandlerUri, ReportPreviewHandlerUri, QueryBuilderHandlerUri
Document Viewer HandlerUri

For more code samples with custom controllers, review the following example:

View Example: ASP.NET Core Reporting - Best Practices

See Also