Breaking Change T1033022
Visible to All Users

Reporting for MVC - The Report Designer, Web Document Viewer and Query Builder controller classes became obsolete

What Changed

  1. The ReportDesignerApiController, WebDocumentViewerApiController and QueryBuilderApiController classes became obsolete.
  2. We have implemented the following abstract base classes:
    • ReportDesignerApiControllerBase
    • WebDocumentViewerApiControllerBase
    • QueryBuilderApiControllerBase

Reasons for Change

We made controller classes abstract to reduce possible security issues.

Impact on Existing Apps

The Report Designer, Document Viewer and Query Builder controls will not work properly without the controller classes, explicitly implemented by the application developer.

If your application uses controllers instead of http handlers, and the application code does not contain controller implementations, a 404 error occurs when the application attempts to call the controllers.

Affected Apps

This breaking change will affect your ASP.NET MVC application, if you use ReportDesigner, WebDocumentViewer, or QueryBuilder controls configured to work with controllers instead of default http handlers.

How to Update Existing Apps

Implement controller classes

Explicitly declare controllers that descend from the built-in base classes. To implement controller classes, create the ReportControllers.cs file with the following content:

C#
using DevExpress.Web.Mvc.Controllers; // ... public class WebDocumentViewerController : WebDocumentViewerApiControllerBase { } public class ReportDesignerController : ReportDesignerApiControllerBase { } public class QueryBuilderController : QueryBuilderApiControllerBase { }

You can find the file with the required controllers in the attachment. Just add the file to your project.

How to Revert to the Previous Behavior

You cannot revert to the previous behavior.

Disclaimer: The information provided on DevExpress.com and affiliated web properties (including the DevExpress Support Center) is provided "as is" without warranty of any kind. Developer Express Inc disclaims all warranties, either express or implied, including the warranties of merchantability and fitness for a particular purpose. Please refer to the DevExpress.com Website Terms of Use for more information in this regard.

Confidential Information: Developer Express Inc does not wish to receive, will not act to procure, nor will it solicit, confidential or proprietary materials and information from you through the DevExpress Support Center or its web properties. Any and all materials or information divulged during chats, email communications, online discussions, Support Center tickets, or made available to Developer Express Inc in any manner will be deemed NOT to be confidential by Developer Express Inc. Please refer to the DevExpress.com Website Terms of Use for more information in this regard.