BuyLog In
Example E4714
Visible to All Users

Reporting for ASP.NET MVC - How to Generate a Report at Runtime

This example generates a report at runtime and previews it in the Document Viewer or edits it in the Report Designer.

App Screenshot

In this example, the Document Viewer and Report Designer components use a custom service to get a report instance by name. The custom service (CustomReportProvider) implements the IReportProvider interface, and its GetReport method generates a report instance at runtime.

On the Document Viewer page, the report name is passed to the Bind method of WebDocumentViewerExtension.

On the Report Designer page, the report name is passed to the Bind method. To save reports, the Report Designer calls the CustomReportStorageWebExtension service that is the ReportStorageWebExtension class descendant.

Files to Review

Documentation

More Examples

Example Code

ReportAtRuntimeMvcApp/Services/CustomReportProvider.cs 
C#
using DevExpress.DataAccess.Sql;
using DevExpress.XtraPrinting;
using DevExpress.XtraReports.Services;
using DevExpress.XtraReports.UI;
using System.Drawing;

namespace ReportAtRuntimeMvcApp.Services
{
    public class CustomReportProvider : DevExpress.XtraReports.Services.IReportProvider
    {
        public XtraReport GetReport(string id, ReportProviderContext context)
        {
            if (string.IsNullOrEmpty(id))
                return null;
            switch (id)
            {
                case "TestReport":
                    return CreateProductsReport();
            }
            return new XtraReport();
        }
        XtraReport CreateProductsReport()
        {
            XtraReport report = new XtraReport();
            ReportHeaderBand headerBand = new ReportHeaderBand()
            {
                HeightF = 80
            };
            report.Bands.Add(headerBand);
            headerBand.Controls.Add(new XRLabel()
            {
                Text = "Categories Report",
                SizeF = new SizeF(650, 80),
                TextAlignment = TextAlignment.BottomCenter,
                Font = new Font("Arial", 36)
            });
            DetailBand detailBand = new DetailBand();
            report.Bands.Add(detailBand);
            XRPictureBox pbPicture = new XRPictureBox()
            {
                LocationF = new PointF(10, 10),
                SizeF = new SizeF(190, 90),
                Sizing = ImageSizeMode.ZoomImage
            };
            pbPicture.ExpressionBindings.Add(new ExpressionBinding("Image", "Picture"));
            detailBand.Controls.Add(pbPicture);
            XRLabel lbCategoryName = new XRLabel()
            {
                LocationF = new PointF(200, 10),
                SizeF = new SizeF(440, 50),
                TextAlignment = TextAlignment.BottomLeft,
                Font = new Font("Arial", 24)
            };
            lbCategoryName.ExpressionBindings.Add(new ExpressionBinding("Text", "CategoryName"));
            detailBand.Controls.Add(lbCategoryName);
            XRLabel lbDescription = new XRLabel()
            {
                LocationF = new PointF(200, 60),
                SizeF = new SizeF(440, 40),
                TextAlignment = TextAlignment.TopLeft,
                Font = new Font("Arial", 14, FontStyle.Italic)
            };
            lbDescription.ExpressionBindings.Add(new ExpressionBinding("Text", "Description"));
            detailBand.Controls.Add(lbDescription);
            report.DataSource = CreateDataSource();
            report.DataMember = "Categories";
            return report;
        }

        private object CreateDataSource()
        {
            var ds = new SqlDataSource("nwind");
            SelectQuery query = SelectQueryFluentBuilder.AddTable("Categories")
                .SelectAllColumns()
                .Build("Categories");
            ds.Queries.Add(query);
            ds.Fill();
            return ds;
        }
    }
}
ReportAtRuntimeMvcApp/ReportAtRuntimeMvcApp/Services/CustomReportProvider.vb 
Visual Basic
Imports DevExpress.DataAccess.Sql
Imports DevExpress.XtraPrinting
Imports DevExpress.XtraReports.Services
Imports DevExpress.XtraReports.UI
Imports System.Drawing

Public Class CustomReportProvider
    Implements DevExpress.XtraReports.Services.IReportProvider

    Public Function GetReport(ByVal id As String, ByVal context As ReportProviderContext) As XtraReport Implements IReportProvider.GetReport
        If String.IsNullOrEmpty(id) Then
            Return Nothing
        End If
        Select Case id
            Case "TestReport"
                Return CreateProductsReport()
        End Select
        Return New XtraReport()
    End Function
    Private Function CreateProductsReport() As XtraReport
        Dim report As New XtraReport()
        Dim headerBand As New ReportHeaderBand() With {.HeightF = 80}
        report.Bands.Add(headerBand)
        headerBand.Controls.Add(New XRLabel() With {.Text = "Categories Report", .SizeF = New SizeF(650, 80), .TextAlignment = TextAlignment.BottomCenter, .Font = New Font("Arial", 36)})
        Dim detailBand As New DetailBand()
        report.Bands.Add(detailBand)
        Dim pbPicture As New XRPictureBox() With {.LocationF = New PointF(10, 10), .SizeF = New SizeF(190, 90), .Sizing = ImageSizeMode.ZoomImage}
        pbPicture.ExpressionBindings.Add(New ExpressionBinding("Image", "Picture"))
        detailBand.Controls.Add(pbPicture)
        Dim lbCategoryName As New XRLabel() With {.LocationF = New PointF(200, 10), .SizeF = New SizeF(440, 50), .TextAlignment = TextAlignment.BottomLeft, .Font = New Font("Arial", 24)}
        lbCategoryName.ExpressionBindings.Add(New ExpressionBinding("Text", "CategoryName"))
        detailBand.Controls.Add(lbCategoryName)
        Dim lbDescription As New XRLabel() With {.LocationF = New PointF(200, 60), .SizeF = New SizeF(440, 40), .TextAlignment = TextAlignment.TopLeft, .Font = New Font("Arial", 14, FontStyle.Italic)}
        lbDescription.ExpressionBindings.Add(New ExpressionBinding("Text", "Description"))
        detailBand.Controls.Add(lbDescription)
        report.DataSource = CreateDataSource()
        report.DataMember = "Categories"
        Return report
    End Function

    Private Function CreateDataSource() As Object
        Dim ds = New SqlDataSource("nwind")
        Dim query As SelectQuery = SelectQueryFluentBuilder.AddTable("Categories").SelectAllColumns().Build("Categories")
        ds.Queries.Add(query)
        ds.Fill()
        Return ds
    End Function
End Class
ReportAtRuntimeMvcApp/Global.asax.cs 
C#
using System;
using System.Collections.Generic;
using System.Linq;
using System.IO;
using System.Web;
using System.Web.Http;
using System.Web.Mvc;
using System.Web.Routing;
            
using DevExpress.Web.Mvc;
using ReportAtRuntimeMvcApp.Services;
using DevExpress.XtraReports.Services;

namespace ReportAtRuntimeMvcApp {
    // Note: For instructions on enabling IIS6 or IIS7 classic mode, 
    // visit http://go.microsoft.com/?LinkId=9394801

    public class MvcApplication : System.Web.HttpApplication {
        protected void Application_Start() {
            DevExpress.XtraReports.Configuration.Settings.Default.UserDesignerOptions.DataBindingMode = DevExpress.XtraReports.UI.DataBindingMode.Expressions;
            DevExpress.XtraReports.Web.WebDocumentViewer.Native.WebDocumentViewerBootstrapper.SessionState = System.Web.SessionState.SessionStateBehavior.Default;
            DevExpress.XtraReports.Web.QueryBuilder.Native.QueryBuilderBootstrapper.SessionState = System.Web.SessionState.SessionStateBehavior.Default;
            DevExpress.XtraReports.Web.ReportDesigner.Native.ReportDesignerBootstrapper.SessionState = System.Web.SessionState.SessionStateBehavior.Default;
            DevExpress.XtraReports.Web.Extensions.ReportStorageWebExtension.RegisterExtensionGlobal(new CustomReportStorageWebExtension(Server.MapPath("/Reports")));

            DevExpress.XtraReports.Web.WebDocumentViewer.DefaultWebDocumentViewerContainer.Register<IReportProvider, CustomReportProvider>();
            DevExpress.XtraReports.Web.ReportDesigner.DefaultReportDesignerContainer.Register<IReportProvider, CustomReportProvider>();

            System.Net.ServicePointManager.SecurityProtocol |= System.Net.SecurityProtocolType.Tls12;
            MVCxReportDesigner.StaticInitialize();

            DevExpress.XtraReports.Web.ClientControls.LoggerService.Initialize((ex, message) => System.Diagnostics.Debug.WriteLine("[{0}]: Exception occurred. Message: '{1}'. Exception Details:\r\n{2}", DateTime.Now, message, ex));
            AreaRegistration.RegisterAllAreas();

            GlobalConfiguration.Configure(WebApiConfig.Register);
            FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
            RouteConfig.RegisterRoutes(RouteTable.Routes);
            
            ModelBinders.Binders.DefaultBinder = new DevExpress.Web.Mvc.DevExpressEditorsBinder();

            DevExpress.Web.ASPxWebControl.CallbackError += Application_Error;
        }

        protected void Application_Error(object sender, EventArgs e) {
            Exception exception = System.Web.HttpContext.Current.Server.GetLastError();
            //TODO: Handle Exception
        }
    }
}
ReportAtRuntimeMvcApp/ReportAtRuntimeMvcApp/Global.asax.vb 
Visual Basic
' Note: For instructions on enabling IIS6 or IIS7 classic mode, 
' visit http://go.microsoft.com/?LinkId=9394802
Imports System.Web.Http

Imports DevExpress.Web.Mvc
Imports DevExpress.XtraReports.Services
Imports ReportAtRuntimeMvcApp.Services

Public Class MvcApplication
    Inherits System.Web.HttpApplication

    Sub Application_Start()
        DevExpress.XtraReports.Configuration.Settings.Default.UserDesignerOptions.DataBindingMode = DevExpress.XtraReports.UI.DataBindingMode.Expressions
        DevExpress.XtraReports.Web.WebDocumentViewer.Native.WebDocumentViewerBootstrapper.SessionState = System.Web.SessionState.SessionStateBehavior.Default
        DevExpress.XtraReports.Web.QueryBuilder.Native.QueryBuilderBootstrapper.SessionState = System.Web.SessionState.SessionStateBehavior.Default
        DevExpress.XtraReports.Web.ReportDesigner.Native.ReportDesignerBootstrapper.SessionState = System.Web.SessionState.SessionStateBehavior.Default
        DevExpress.XtraReports.Web.Extensions.ReportStorageWebExtension.RegisterExtensionGlobal(New CustomReportStorageWebExtension(Server.MapPath("/Reports")))

        DevExpress.XtraReports.Web.WebDocumentViewer.DefaultWebDocumentViewerContainer.Register(Of IReportProvider, CustomReportProvider)()
        DevExpress.XtraReports.Web.ReportDesigner.DefaultReportDesignerContainer.Register(Of IReportProvider, CustomReportProvider)()
        System.Net.ServicePointManager.SecurityProtocol = System.Net.ServicePointManager.SecurityProtocol Or System.Net.SecurityProtocolType.Tls12
        MVCxReportDesigner.StaticInitialize()
        DevExpress.XtraReports.Web.ClientControls.LoggerService.Initialize(Sub(ex, message)
                                                                               System.Diagnostics.Debug.WriteLine("[{0}]: Exception occurred. Message: '{1}'. Exception Details:\r\n{2}", DateTime.Now, message, ex)
                                                                           End Sub)
        AreaRegistration.RegisterAllAreas()

        GlobalConfiguration.Configure(AddressOf WebApiConfig.Register)
        FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters)
        RouteConfig.RegisterRoutes(RouteTable.Routes)

        ModelBinders.Binders.DefaultBinder = New DevExpress.Web.Mvc.DevExpressEditorsBinder()

        AddHandler DevExpress.Web.ASPxWebControl.CallbackError, AddressOf Application_Error
    End Sub

    Protected Sub Application_Error(ByVal sender As Object, ByVal e As EventArgs)
        Dim exception As Exception = System.Web.HttpContext.Current.Server.GetLastError()
        'TODO: Handle Exception
    End Sub
End Class

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.