[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
 [Expand]Product Information
 [Expand]Get Started with DevExpress Reporting
 [Expand]Create Popular Reports
 [Expand]Detailed Guide to DevExpress Reporting
 [Expand]Visual Studio Report Designer
 [Collapse]Create End-User Reporting Applications
   Cross-Platform Reporting
  [Expand]WinForms Reporting
  [Collapse]WPF Reporting
   [Expand]Document Preview
   [Collapse]End-User Report Designer
    [Expand]Quick Start
    [Collapse]API and Customization
      Specify the Report Designer View
      Store Reports in the Report Designer
      Customize the Report Designer Toolbar
      Customize Context Menus in the Report Designer
      Add a Custom Control to the Report Designer Toolbox
      Hide Dock Panels in the Report Designer
      Register Custom Report Parameter Types
      Customize Report Designer Commands and Hot Keys
      Customize Smart Tags
      Hide Properties from the Report Designer
      Use Favorite Properties in the Report Designer
      Wizard Customization Overview
      Remove Data Providers from the Report Wizard
      Register a Custom Page in the Report Wizard
      Use the Query Builder Light Mode
   [Expand]Application Security
   [Expand]Application Appearance
    Application Deployment
    End-User Documentation
  [Expand]Web Reporting
  [Expand]WCF Report Service
  [Expand]Discontinued Platforms
   Redistribution and Deployment
 [Expand]API Reference
[Expand]Report and Dashboard Server
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

Wizard Customization Overview

The Report Wizard allows you to create new reports and customize existing ones in the End-User Report Designer. The Report Wizard includes Data Source Wizard pages for binding a report to data and adds extra pages for configuring the report layout.

Expanded Wizard Structural Elements

The Wizard architecture conforms to the MVP (Model-View-Presenter) design pattern and includes the following structural elements:

  • Presenter

    A page Presenter defines the logic to initialize a page, process data on this page and pass the data between a View and Model.

    Each page Presenter should descend from the abstract WizardPageBase<TView, TModel> class (from the DevExpress.Data.WizardFramework namespace). The TView and TModel type parameters allow you to associate the page Presenter with an appropriate View and Model.

  • View

    A page View relies on the MVVM design pattern. Each View consists of a ViewModel that processes data that is displayed in the user interface and a XAML template that defines the page's visual appearance and layout.

    A ViewModel should inherit the WizardPageBase class (from the DevExpress.Xpf.DataAccess.DataSourceWizard namespace) and implement the corresponding View interface.

    The XAML template should reference the corresponding ViewModel type by a Key.

  • Model

    The ReportModel class stores settings defined on the Report Wizard pages. The XtraReportModel class accumulates these settings and data-related settings specified on the Data Source Wizard pages.

    Override the Equals method to take all the model settings into account when you create a model descendant and add custom fields to it.

You can create a custom wizard page using the following approaches:

  • Provide your custom appearance for a specific wizard page by creating a XAML template with the required ViewModel type referenced by a Key. The specified Key is used to locate the corresponding template automatically.
  • Customize an existing wizard page by inheriting from its Presenter and View objects.

    The following documents list the default page Presenters and Views used in the Data Source and Report wizards:

  • Create a custom wizard page from scratch by implementing a page Presenter, View, and Model (optional). Inherit the page Presenter from the abstract WizardPageBase<TView, TModel> class (the DevExpress.Data.WizardFramework namespace). To implement the View, inherit a ViewModel from the WizardPageBase class (the DevExpress.Xpf.DataAccess.DataSourceWizard namespace) and write a XAML template. To add custom fields to the Model, create the XtraReportModel class descendant.

Expanded Wizard Customization API

You can customize the Report and/or Data Source Wizard by implementing the IWizardCustomizationService interface, which provides the following four methods:

Both the CustomizeDataSourceWizard and CustomizeReportWizard methods receive two arguments:

To apply the wizard customization, assign your custom IWizardCustomizationService instance to the ReportDesignerBase.ServicesRegistry property.

Expanded Code Examples

The following code examples demonstrate how to customize the Report Wizard:

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