[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Collapse]Reporting
 [Expand]Product Information
 [Expand]Get Started with DevExpress Reporting
 [Expand]Create Popular Reports
 [Expand]Detailed Guide to DevExpress Reporting
 [Expand]Visual Studio Report Designer
 [Expand]Create End-User Reporting Applications
 [Collapse]API Reference
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraPrinting.Caching
  [Expand]DevExpress.XtraReports
  [Expand]DevExpress.XtraReports.CodeCompletion
  [Expand]DevExpress.XtraReports.CodeCompletion.Storages
  [Expand]DevExpress.XtraReports.Configuration
  [Expand]DevExpress.XtraReports.Data
  [Expand]DevExpress.XtraReports.Design
  [Expand]DevExpress.XtraReports.Expressions
  [Expand]DevExpress.XtraReports.Extensions
  [Expand]DevExpress.XtraReports.FavoriteProperties
  [Expand]DevExpress.XtraReports.Localization
  [Expand]DevExpress.XtraReports.Native
  [Expand]DevExpress.XtraReports.ReportGallery
  [Expand]DevExpress.XtraReports.ReportGeneration
  [Expand]DevExpress.XtraReports.Security
  [Expand]DevExpress.XtraReports.Serialization
  [Expand]DevExpress.XtraReports.Service
  [Expand]DevExpress.XtraReports.Service.Extensions
  [Expand]DevExpress.XtraReports.Templates
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraReports.UI.BarCode
  [Expand]DevExpress.XtraReports.UI.PivotGrid
  [Expand]DevExpress.XtraReports.UserDesigner
  [Collapse]DevExpress.XtraReports.Web
   [Expand]ASPxDocumentViewer Class
   [Expand]ASPxQueryBuilder Class
   [Collapse]ASPxReportDesigner Class
     ASPxReportDesigner Members
    [Expand]ASPxReportDesigner Constructor
    [Expand]ASPxReportDesigner Properties
    [Expand]ASPxReportDesigner Events
    [Expand]ASPxReportDesigner Methods
   [Expand]ASPxWebDocumentViewer Class
   [Expand]BookmarkFiller<T> Class
   [Expand]CachedReportSourceWeb Class
   [Expand]CacheReportDocumentEventArgs Class
    CacheReportDocumentEventHandler Delegate
   [Expand]CanProcessHandlerRequestEventArgs Class
   [Expand]CustomizeParameterEditorsEventArgs Class
   [Expand]DeserializeClientParameterEventArgs Class
    ImagesEmbeddingMode Enumeration
   [Expand]ReportDesignerClientSideEvents Class
   [Expand]ReportDocumentMap Class
   [Expand]ReportDocumentMapStyles Class
   [Expand]ReportParametersPanel Class
   [Expand]ReportParametersPanelEditorCaptionSettings Class
   [Expand]ReportParametersPanelEditorStyles Class
   [Expand]ReportToolbar Class
   [Expand]ReportToolbarBoxStyle Class
   [Expand]ReportToolbarButton Class
   [Expand]ReportToolbarButtonStyle Class
   [Expand]ReportToolbarClientSideEvents Class
   [Expand]ReportToolbarComboBoxStyle Class
   [Expand]ReportToolbarEditorCaptionSettings Class
   [Expand]ReportToolbarImages Class
   [Expand]ReportToolbarItem Class
   [Expand]ReportToolbarItemCollection Class
    ReportToolbarItemKind Enumeration
   [Expand]ReportToolbarLabel Class
   [Expand]ReportToolbarLabelStyle Class
   [Expand]ReportToolbarMenuStyle Class
   [Expand]ReportToolbarStyles Class
   [Expand]ReportViewer Class
   [Expand]ReportViewerClientSideEvents Class
   [Expand]RestoreReportDocumentFromCacheEventArgs Class
    RestoreReportDocumentFromCacheEventHandler Delegate
   [Expand]SaveQueryEventArgs Class
   [Expand]SaveReportLayoutEventArgs Class
    SaveReportLayoutEventHandler Delegate
   [Expand]SiteMapBookmarkFiller Class
   [Expand]WebDocumentViewerClientSideEvents Class
  [Expand]DevExpress.XtraReports.Web.Azure.ReportDesigner
  [Expand]DevExpress.XtraReports.Web.Azure.WebDocumentViewer
  [Expand]DevExpress.XtraReports.Web.ClientControls
  [Expand]DevExpress.XtraReports.Web.ClientControls.DataContracts
  [Expand]DevExpress.XtraReports.Web.DocumentViewer
  [Expand]DevExpress.XtraReports.Web.DocumentViewer.Ribbon
  [Expand]DevExpress.XtraReports.Web.Extensions
  [Expand]DevExpress.XtraReports.Web.Localization
  [Expand]DevExpress.XtraReports.Web.QueryBuilder
  [Expand]DevExpress.XtraReports.Web.QueryBuilder.Native
  [Expand]DevExpress.XtraReports.Web.QueryBuilder.Services
  [Expand]DevExpress.XtraReports.Web.ReportDesigner
  [Expand]DevExpress.XtraReports.Web.ReportDesigner.DataContracts
  [Expand]DevExpress.XtraReports.Web.ReportDesigner.Native
  [Expand]DevExpress.XtraReports.Web.ReportDesigner.Services
  [Expand]DevExpress.XtraReports.Web.Scripts
  [Expand]DevExpress.XtraReports.Web.WebDocumentViewer
  [Expand]DevExpress.XtraReports.Web.WebDocumentViewer.DataContracts
  [Expand]DevExpress.XtraReports.Web.WebDocumentViewer.Native
  [Expand]DevExpress.XtraReports.Wizards
  [Expand]DevExpress.XtraReports.Wizards.Builder
  [Expand]DevExpress.XtraReports.Wizards.ColorSchemes
  [Expand]DevExpress.XtraReports.Wizards.Labels
  [Expand]DevExpress.XtraReports.Wizards.Presenters
  [Expand]DevExpress.XtraReports.Wizards.Templates
  [Expand]DevExpress.XtraReports.Wizards.Views
  [Expand]DevExpress.XtraReports.Wizards3
  [Expand]DevExpress.XtraReports.Wizards3.Presenters
  [Expand]DevExpress.XtraReports.Wizards3.Views
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

ASPxReportDesigner Class

A control to create an End-User Report Designer in ASP.NET applications.

Namespace:DevExpress.XtraReports.Web
Assembly:DevExpress.XtraReports.v19.1.Web.WebForms.dll

Expanded Syntax

Expanded Remarks

Quick Start

To add the End-User Report Designer to a web page, do the following.

  1. In Visual Studio, expand the DX.19.1: Reporting Toolbox tab and drop the ASPxReportDesigner control onto the page.

  2. Assign a report to the Report Designer by calling the OpenReport or OpenReportXmlLayout method.

    To restore a report layout from a file or stream, call the XtraReport.FromFile or XtraReport.LoadLayout method.

  3. In the application's Web.config file, add the "resources" section as shown below.

    Alternatively, to avoid automatic loading of any libraries by a control (e.g., when such libraries are already referenced on the web page), declare an empty "resources" section and manually attach DevExtreme resources and the required third-party libraries to the web page.

    Deleting the DevExpress "resources" section from the Web.config file will enable the default behavior (with automatic loading of only DevExtreme, without adding third-party libraries).

    To learn more about this configuration, see Embedding Third-Party Libraries.

  4. To enable the Report Designer to use an HttpContext (Session or User), specify the Session State property in the control's smart tag.

    This will add all necessary handlers to the application's Web.config file and register them at the application startup in the Global.asax file.

  5. In Visual Studio 2012 and later versions, you need to exclude the directory with the default visual themes, along with the site.css file that is created automatically by the project because they may corrupt the layout of the document viewer toolbar. To do this, press CTRL+ALT+L to switch to the Solution Explorer, and remove the themes folder and Site.css file from the Content directory.

  6. Implement a Report Storage that will be used to store reports created in the Report Designer. Enabling this feature is required to support editing of subreports.
  7. If required, you can register default data sources that will be available for all report design sessions in the Report Designer.
  8. If required, you can also register default data connections that will be available in the Data Source Wizard when creating new data sources.

To learn more, see Report Designer.

Expanded Inheritance Hierarchy

System.Object
    System.Web.UI.Control
       System.Web.UI.WebControls.WebControl
          ASPxWebControlBase
             ASPxWebControl
                ASPxWebClientUIControl
                   ASPxReportDesigner

Expanded See Also

Is this topic helpful?​​​​​​​