ASPxWebDocumentViewer.OpenReport(String) Method

Opens the specified report in the ASPxWebDocumentViewer.

Namespace: DevExpress.XtraReports.Web

Assembly: DevExpress.XtraReports.v24.2.Web.WebForms.dll

NuGet Package: DevExpress.Web.Reporting

Declaration

C#

public void OpenReport(
    string reportUrl
)

VB.NET

Public Sub OpenReport(
    reportUrl As String
)

Parameters

Name	Type	Description
reportUrl	String	A String value specifying a report unique name.

Remarks

You must implement a report name resolution service to convert the report name to a report instance when you use this method overload and pass a string that specifies the report name to the method.

If your application does not include the Report Designer component, implement and register the IReportProvider service.

The following code snippet is a sample implementation of the IReportProvider service that loads a report from a file located in the Reports folder:

C#

using System.Web;
using DevExpress.XtraReports.Services;
using DevExpress.XtraReports.UI;
// ...
    public class CustomReportProvider : IReportProvider {
        public XtraReport GetReport(string id, ReportProviderContext context) {
            if (string.IsNullOrEmpty(id))
                return null;
            XtraReport report = new XtraReport();
            switch (id) {
                case "TestReport1":
                    report.LoadLayoutFromXml(HttpContext.Current.Server.MapPath("Reports//TestReport1.repx"));
                    return report;
            }
            return report;
        }
    }

VB.NET

Imports System.Web
Imports DevExpress.XtraReports.Services
Imports DevExpress.XtraReports.UI
' ...
    Public Class CustomReportProvider
        Implements IReportProvider

        Public Function GetReport(ByVal id As String, ByVal context As ReportProviderContext) As XtraReport
            If String.IsNullOrEmpty(id) Then
                Return Nothing
            End If
            Dim report As New XtraReport()
            Select Case id
                Case "TestReport1"
                    report.LoadLayoutFromXml(HttpContext.Current.Server.MapPath("Reports//TestReport1.repx"))
                    Return report
            End Select
            Return report
        End Function
    End Class

Register the service on application startup before calling the StaticInitialize() method:

Global.asax.cs

void Application_Start(object sender, EventArgs e) {
    // ...
    DevExpress.XtraReports.Web.WebDocumentViewer.DefaultWebDocumentViewerContainer.Register<IReportProvider, CustomReportProvider>();
    // ...
    ASPxReportDesigner.StaticInitialize();
    // ...
} 

VB.NET

Private Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
    ' ...
    DevExpress.XtraReports.Web.WebDocumentViewer.DefaultWebDocumentViewerContainer.Register(Of IReportProvider, CustomReportProvider)()
    ' ...
    ASPxReportDesigner.StaticInitialize()
    ' ...
End Sub

If the application includes the Report Designer component, you must implement a descendant of ReportStorageWebExtension that works with both Document Viewer and Report Designer.

If both IReportProvider and ReportStorageWebExtension services are registered, the Document Viewer requests IReportProvider and the Report Designer requests ReportStorageWebExtension.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the OpenReport(String) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

reporting-web-forms-localization/CS/SubstituteLocalizationStringsExample/Viewer.aspx.cs#L10

protected void Page_Load(object sender, EventArgs e) {
    ASPxWebDocumentViewer1.OpenReport("Invoice");
}

reporting-web-forms-customize-document-viewer-toolbar/CS/DXWebApplication1/Viewer.aspx.cs#L10

protected void Page_Load(object sender, EventArgs e) {
    ASPxWebDocumentViewer1.OpenReport("Report");
}

reporting-web-mvc-viewer-clustering/CS/DevExpressWebFarmsWebGardenReporting/viewer.aspx.cs#L11

protected void Page_Load(object sender, EventArgs e) {
    ASPxWebDocumentViewer1.OpenReport("Invoice");
}

reporting-web-object-data-source/CS/Reporting-How-To-Use-Object-Data-Source/WebForms/CS/Reporting_ObjectDS_WebForms/Viewer.aspx.cs#L7

protected void Page_Load(object sender, EventArgs e) {
    ASPxWebDocumentViewer1.OpenReport("EmployeeReportParameter");
}

VB.NET

reporting-web-forms-localization/VB/SubstituteLocalizationStringsExample/Viewer.aspx.vb#L13

Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
    ASPxWebDocumentViewer1.OpenReport("Invoice")
End Sub

reporting-web-forms-customize-document-viewer-toolbar/VB/DXWebApplication1/Viewer.aspx.vb#L11

Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
    ASPxWebDocumentViewer1.OpenReport("Report")
End Sub

reporting-web-mvc-viewer-clustering/VB/DevExpressWebFarmsWebGardenReporting/viewer.aspx.vb#L13

Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
    ASPxWebDocumentViewer1.OpenReport("Invoice")
End Sub

reporting-web-object-data-source/CS/Reporting-How-To-Use-Object-Data-Source/WebForms/VB/Reporting_ObjectDS_WebForms/Viewer.aspx.vb#L8

Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
    ASPxWebDocumentViewer1.OpenReport("EmployeeReportParameter")
End Sub