Reporting for WPF - How to Register a Custom Page in the Report Wizard for the End-User Report Designer

This example demonstrates how to extend the Report Wizard in the End-User Report Designer with a custom page that allows you to edit the report page settings. This page is displayed after selecting the report type (for empty and data-bound reports).

Implementation Details

To accomplish this task, perform the following steps:

Create the Presenter class as the DevExpress.Data.WizardFramework.WizardPageBase<TView, TModel> class descendant. Implement the logic to pass data between a Model and View, specify the next wizard page type, and define which page buttons should be available.
Declare an interface that identifies the wizard page View.
Create the ViewModel class as the DevExpress.Xpf.DataAccess.DataSourceWizard.WizardPageBase class descendant that implements the interface declared above. This ViewModel class processes data to display it in the User Interface.
Write an XAML template with the ViewModel type referenced by a Key to define the page's visual appearance and layout. The specified Key is used to automatically locate the corresponding template.
5. Create an XtraReportModel class descendant. Add custom fields to store the report page settings and override the Equals method to take into account the added fields.
Override the existing ChooseReportTypePage to set the next page to your custom one.
Implement the IWizardCustomizationService interface, which provides four methods for wizard customization. In this implementation, register the previously created Presenters, ViewModel, and Model, and write the logic to build a report.

Files to Review

CustomReportModel.cs (VB:CustomReportModel.vb)
ChoosePageSettingsPage.cs (VB:ChoosePageSettingsPage.vb)
CustomChooseReportTypePage.cs (VB:CustomChooseReportTypePage.vb)
WizardCustomizationService.cs (VB:WizardCustomizationService.vb)

More Examples

WPF Report Designer - How to customize the list of data providers in the Data Source Wizard

Does this example address your development requirements/objectives?

(you will be redirected to DevExpress.com to submit your response)

Example Code

CustomReportModel.cs(vb)

C#
VB.NET

C#
using DevExpress.XtraReports.Wizards;
using System.Drawing.Printing;

namespace CustomReportWizard {
    class CustomReportModel : XtraReportModel {
        public PaperKind PaperKind { get; set; }
        public Margins PageMargins { get; set; }

        public CustomReportModel() {
            PaperKind = PaperKind.Letter;
            PageMargins = new Margins(100, 100, 100, 100);
        }
        public CustomReportModel(CustomReportModel model) : base(model) {
            PaperKind = model.PaperKind;
            PageMargins = new Margins(model.PageMargins.Left, model.PageMargins.Right, model.PageMargins.Top, model.PageMargins.Bottom);
        }

        public override object Clone() {
            return new CustomReportModel(this);
        }

        public override bool Equals(object obj) {
            var other = obj as CustomReportModel;
            return other != null
                && base.Equals(obj)
                && PaperKind == other.PaperKind
                && PageMargins == other.PageMargins;
        }

        public override int GetHashCode() {
            return base.GetHashCode() ^ PaperKind.GetHashCode() ^ PageMargins.GetHashCode();
        }
    }
}

Visual Basic
Imports DevExpress.XtraReports.Wizards
Imports System.Drawing.Printing

Namespace CustomReportWizard
    Friend Class CustomReportModel
        Inherits XtraReportModel

        Public Property PaperKind() As PaperKind
        Public Property PageMargins() As Margins

        Public Sub New()
            PaperKind = PaperKind.Letter
            PageMargins = New Margins(100, 100, 100, 100)
        End Sub
        Public Sub New(ByVal model As CustomReportModel)
            MyBase.New(model)
            PaperKind = model.PaperKind
            PageMargins = New Margins(model.PageMargins.Left, model.PageMargins.Right, model.PageMargins.Top, model.PageMargins.Bottom)
        End Sub

        Public Overrides Function Clone() As Object
            Return New CustomReportModel(Me)
        End Function

        Public Overrides Function Equals(ByVal obj As Object) As Boolean
            Dim other = TryCast(obj, CustomReportModel)
            Return other IsNot Nothing AndAlso MyBase.Equals(obj) AndAlso PaperKind = other.PaperKind AndAlso PageMargins Is other.PageMargins
        End Function

        Public Overrides Function GetHashCode() As Integer
            Return MyBase.GetHashCode() Xor PaperKind.GetHashCode() Xor PageMargins.GetHashCode()
        End Function
    End Class
End Namespace

ChoosePageSettingsPage.cs(vb)

C#
VB.NET

C#
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Drawing.Printing;
using System.Linq;
using DevExpress.Data.WizardFramework;
using DevExpress.DataAccess.Wizard.Presenters;
using DevExpress.Mvvm.DataAnnotations;
using DevExpress.XtraReports.Wizards;

namespace CustomReportWizard {
    class ChoosePageSettingsPage<TModel> : WizardPageBase<IChoosePageSettingsPageView, TModel>, IWizardPage<XtraReportModel> 
        where TModel : CustomReportModel { XtraReportModel IWizardPage<XtraReportModel>.Model 
            { get { return Model; } set { Model = (TModel)value; } }

        public ChoosePageSettingsPage(IChoosePageSettingsPageView view) : base(view) { }

        public override bool FinishEnabled { get { return Model.ReportType == ReportType.Empty; } }
        public override bool MoveNextEnabled { get { return Model.ReportType != ReportType.Empty; } }

        public override Type GetNextPageType() { return Model.ReportType == ReportType.Empty 
                ? null 
                : typeof(ChooseDataSourceTypePage<XtraReportModel>); }

        public override void Begin() {
            View.PaperKind = Model.PaperKind;
            View.Portrait = Model.Portrait;
            View.PageMargins = Model.PageMargins;
        }

        public override void Commit() {
            Model.PaperKind = View.PaperKind;
            Model.Portrait = View.Portrait;
            Model.PageMargins = View.PageMargins;
        }
    }

    interface IChoosePageSettingsPageView {
        PaperKind PaperKind { get; set; }
        bool Portrait { get; set; }
        Margins PageMargins { get; set; }
    }
    [POCOViewModel(ImplementIDataErrorInfo = true)]
    public class ChoosePageSettingsPageViewModel : DevExpress.Xpf.DataAccess.DataSourceWizard.WizardPageBase, 
        IChoosePageSettingsPageView {

        public override string Description { get { return "Choose the required page settings."; } }

        public virtual IEnumerable<PaperKindViewInfo> AvailablePaperKinds {get; protected set;}
        public virtual PaperKindViewInfo SelectedPaperKind { get; set; }

        public virtual bool Portrait { get; set; }

        [Range(0,300)]
        public virtual int LeftMargin { get; set; }
        [Range(0, 300)]
        public virtual int RightMargin { get; set; }
        [Range(0, 300)]
        public virtual int TopMargin { get; set; }
        [Range(0, 300)]
        public virtual int BottomMargin { get; set; }

        PaperKind IChoosePageSettingsPageView.PaperKind {
            get { return (PaperKind)SelectedPaperKind.Id; }
            set { SetPaperKind(value); }
        }
        Margins IChoosePageSettingsPageView.PageMargins {
            get { return new Margins(LeftMargin, RightMargin, TopMargin, BottomMargin); }
            set { SetMargins(value); }
        }

        public ChoosePageSettingsPageViewModel() {
            var printerSettings = new PrinterSettings();
            AvailablePaperKinds = printerSettings.PaperSizes.Cast<PaperSize>().Select(paperSize => {
                return new PaperKindViewInfo() {
                    Id = (int)paperSize.Kind,
                    DisplayName = paperSize.PaperName,
                    SizeText = string.Format("{0}x{1}", paperSize.Width, paperSize.Height) };
            }).ToArray();
        }

        void SetPaperKind(PaperKind value) {
            var info = AvailablePaperKinds.SingleOrDefault(x => (PaperKind)x.Id == value)
                ?? AvailablePaperKinds.Single(x => (PaperKind)x.Id == PaperKind.Letter);
            SelectedPaperKind = info;
        }

        void SetMargins(Margins value) {
            LeftMargin = value.Left;
            RightMargin = value.Right;
            TopMargin = value.Top;
            BottomMargin = value.Bottom;
        }
    }
}

Visual Basic
Imports System.ComponentModel.DataAnnotations
Imports System.Drawing.Printing
Imports DevExpress.Data.WizardFramework
Imports DevExpress.DataAccess.Wizard.Presenters
Imports DevExpress.Mvvm.DataAnnotations
Imports DevExpress.XtraReports.Wizards

Namespace CustomReportWizard
    Friend Class ChoosePageSettingsPage(Of TModel As CustomReportModel)
        Inherits WizardPageBase(Of IChoosePageSettingsPageView, TModel)
        Implements IWizardPage(Of XtraReportModel)

        Public Sub New(ByVal view As IChoosePageSettingsPageView)
            MyBase.New(view)
        End Sub

        Public Overrides ReadOnly Property FinishEnabled() As Boolean
            Get
                Return Model.ReportType = ReportType.Empty
            End Get
        End Property
        Public Overrides ReadOnly Property MoveNextEnabled() As Boolean
            Get
                Return Model.ReportType <> ReportType.Empty
            End Get
        End Property

        Private Property IWizardPage_Model As XtraReportModel Implements IWizardPage(Of XtraReportModel).Model
            Get
                Return Model
            End Get
            Set(ByVal value As XtraReportModel)
                Model = CType(value, TModel)
            End Set
        End Property

        Public Overrides Function GetNextPageType() As Type
            Return If(Model.ReportType = ReportType.Empty, Nothing, GetType(ChooseDataSourceTypePage(Of XtraReportModel)))
        End Function

        Public Overrides Sub Begin()
            View.PaperKind = Model.PaperKind
            View.Portrait = Model.Portrait
            View.PageMargins = Model.PageMargins
        End Sub

        Public Overrides Sub Commit()
            Model.PaperKind = View.PaperKind
            Model.Portrait = View.Portrait
            Model.PageMargins = View.PageMargins
        End Sub

#Region "IWizardPage"
        Private ReadOnly Property IWizardPage_MoveNextEnabled As Boolean Implements IWizardPage(Of XtraReportModel).MoveNextEnabled
            Get
                Return MoveNextEnabled
            End Get
        End Property

        Private ReadOnly Property IWizardPage_FinishEnabled As Boolean Implements IWizardPage(Of XtraReportModel).FinishEnabled
            Get
                Return FinishEnabled
            End Get
        End Property

        Private ReadOnly Property IWizardPage_PageContent As Object Implements IWizardPage(Of XtraReportModel).PageContent
            Get
                Return PageContent
            End Get
        End Property

        Private Function IWizardPage_GetNextPageType() As Type Implements IWizardPage(Of XtraReportModel).GetNextPageType
            Return GetNextPageType()
        End Function

        Private Function IWizardPage_Validate(ByRef errorMessage As String) As Boolean Implements IWizardPage(Of XtraReportModel).Validate
            Return Validate(errorMessage)
        End Function

        Private Sub IWizardPage_Begin() Implements IWizardPage(Of XtraReportModel).Begin
            Begin()
        End Sub

        Private Event IWizardPage_Changed As EventHandler Implements IWizardPage(Of XtraReportModel).Changed
        Private Event IWizardPage_Error As EventHandler(Of WizardPageErrorEventArgs) Implements IWizardPage(Of XtraReportModel).Error

        Private Sub IWizardPage_Commit() Implements IWizardPage(Of XtraReportModel).Commit
            Commit()
        End Sub
#End Region

    End Class

    Friend Interface IChoosePageSettingsPageView
        Property PaperKind() As PaperKind
        Property Portrait() As Boolean
        Property PageMargins() As Margins
    End Interface
    <POCOViewModel(ImplementIDataErrorInfo := True)> _
    Public Class ChoosePageSettingsPageViewModel
        Inherits DevExpress.Xpf.DataAccess.DataSourceWizard.WizardPageBase
        Implements IChoosePageSettingsPageView

        Public Overrides ReadOnly Property Description() As String
            Get
                Return "Choose the required page settings."
            End Get
        End Property

        Private privateAvailablePaperKinds As IEnumerable(Of PaperKindViewInfo)
        Public Overridable Property AvailablePaperKinds() As IEnumerable(Of PaperKindViewInfo)
            Get
                Return privateAvailablePaperKinds
            End Get
            Protected Set(ByVal value As IEnumerable(Of PaperKindViewInfo))
                privateAvailablePaperKinds = value
            End Set
        End Property
        Public Overridable Property SelectedPaperKind() As PaperKindViewInfo

        Public Overridable Property Portrait() As Boolean Implements IChoosePageSettingsPageView.Portrait

        <Range(0,300)> _
        Public Overridable Property LeftMargin() As Integer
        <Range(0, 300)> _
        Public Overridable Property RightMargin() As Integer
        <Range(0, 300)> _
        Public Overridable Property TopMargin() As Integer
        <Range(0, 300)> _
        Public Overridable Property BottomMargin() As Integer

        Private Property IChoosePageSettingsPageView_PaperKind() As PaperKind Implements IChoosePageSettingsPageView.PaperKind
            Get
                Return CType(SelectedPaperKind.Id, PaperKind)
            End Get
            Set(ByVal value As PaperKind)
                SetPaperKind(value)
            End Set
        End Property
        Private Property IChoosePageSettingsPageView_PageMargins() As Margins Implements IChoosePageSettingsPageView.PageMargins
            Get
                Return New Margins(LeftMargin, RightMargin, TopMargin, BottomMargin)
            End Get
            Set(ByVal value As Margins)
                SetMargins(value)
            End Set
        End Property

        Public Sub New()
            Dim printerSettings = New PrinterSettings()
            AvailablePaperKinds = printerSettings.PaperSizes.Cast(Of PaperSize)().Select(Function(paperSize)
                Return New PaperKindViewInfo() With { _
                    .Id = CInt((paperSize.Kind)), _
                    .DisplayName = paperSize.PaperName, _
                    .SizeText = String.Format("{0}x{1}", paperSize.Width, paperSize.Height) _
                }
            End Function).ToArray()
        End Sub

        Private Sub SetPaperKind(ByVal value As PaperKind)
            Dim info = If(AvailablePaperKinds.SingleOrDefault(Function(x) CType(x.Id, PaperKind) = value), AvailablePaperKinds.Single(Function(x) CType(x.Id, PaperKind) = PaperKind.Letter))
            SelectedPaperKind = info
        End Sub

        Private Sub SetMargins(ByVal value As Margins)
            LeftMargin = value.Left
            RightMargin = value.Right
            TopMargin = value.Top
            BottomMargin = value.Bottom
        End Sub
    End Class
End Namespace

CustomChooseReportTypePage.cs(vb)

C#
VB.NET

C#
using System;
using System.Collections.Generic;
using DevExpress.DataAccess.Sql;
using DevExpress.DataAccess.Wizard;
using DevExpress.DataAccess.Wizard.Services;
using DevExpress.Entity.ProjectModel;
using DevExpress.XtraReports.Wizards;
using DevExpress.XtraReports.Wizards.Presenters;
using DevExpress.XtraReports.Wizards.Views;

namespace CustomReportWizard {
    class CustomChooseReportTypePage : ChooseReportTypePage<XtraReportModel> {
        public CustomChooseReportTypePage(IChooseReportTypePageView view, IConnectionStorageService connectionStorageService,
            DataSourceTypes dataSourceTypes, IWizardRunnerContext context, ISolutionTypesProvider solutionTypesProvider) : 
            base(view, connectionStorageService, dataSourceTypes, context, solutionTypesProvider) { }

        public override bool MoveNextEnabled {
            get { return true; }
        }

        public override Type GetNextPageType() {
            if(View.ReportType == ReportType.Standard || View.ReportType == ReportType.Empty)
                return typeof(ChoosePageSettingsPage<CustomReportModel>);
            return base.GetNextPageType();
        }
    }
}

Visual Basic
Imports DevExpress.DataAccess.Sql
Imports DevExpress.DataAccess.Wizard
Imports DevExpress.DataAccess.Wizard.Services
Imports DevExpress.Entity.ProjectModel
Imports DevExpress.XtraReports.Wizards
Imports DevExpress.XtraReports.Wizards.Presenters
Imports DevExpress.XtraReports.Wizards.Views
Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports System.Text
Imports System.Threading.Tasks

Namespace CustomReportWizard
    Friend Class CustomChooseReportTypePage
        Inherits ChooseReportTypePage(Of XtraReportModel)

        Public Sub New(ByVal view As IChooseReportTypePageView, ByVal connectionStorageService As IConnectionStorageService, ByVal dataSourceTypes As DataSourceTypes, ByVal context As IWizardRunnerContext, ByVal solutionTypesProvider As ISolutionTypesProvider)
            MyBase.New(view, connectionStorageService, dataSourceTypes, context, solutionTypesProvider)
        End Sub

        Public Overrides ReadOnly Property MoveNextEnabled() As Boolean
            Get
                Return True
            End Get
        End Property

        Public Overrides Function GetNextPageType() As Type
            If View.ReportType = ReportType.Standard OrElse View.ReportType = ReportType.Empty Then
                Return GetType(ChoosePageSettingsPage(Of CustomReportModel))
            End If
            Return MyBase.GetNextPageType()
        End Function
    End Class
End Namespace

WizardCustomizationService.cs(vb)

C#
VB.NET

C#
using System;
using DevExpress.DataAccess;
using DevExpress.DataAccess.Wizard;
using DevExpress.DataAccess.Wizard.Model;
using DevExpress.Xpf.DataAccess.DataSourceWizard;
using DevExpress.Xpf.Reports.UserDesigner.ReportWizard;
using DevExpress.XtraReports.UI;
using DevExpress.XtraReports.Wizards;
using DevExpress.XtraReports.Wizards.Presenters;


namespace CustomReportWizard {
    class WizardCustomizationService : IWizardCustomizationService {
        void IDataSourceWizardCustomizationService.CustomizeDataSourceWizard(DataSourceWizardCustomizationModel customization, 
            ViewModelSourceIntegrityContainer container) { }

        void IWizardCustomizationService.CustomizeReportWizard(ReportWizardCustomizationModel customization, 
            ViewModelSourceIntegrityContainer container) {
            customization.Model = new CustomReportModel();
            container.RegisterType<ChoosePageSettingsPage<CustomReportModel>>();
            container.RegisterType<ChooseReportTypePage<XtraReportModel>, CustomChooseReportTypePage>();
            container.RegisterViewModel<IChoosePageSettingsPageView, ChoosePageSettingsPageViewModel>();
        }

        bool IDataSourceWizardCustomizationService.TryCreateDataSource(IDataSourceModel model, out object dataSource, 
            out string dataMember) {
            dataSource = null;
            dataMember = null;
            return false;
        }

        bool IWizardCustomizationService.TryCreateReport(XtraReportModel model, out XtraReport report) {
            var customModel = model as CustomReportModel;
            if(customModel == null || model.ReportType == ReportType.Template || model.ReportType == ReportType.Label) {
                report = null;
                return false;
            }
            IDataComponent dataSource = null;
            string dataMember = null;
            if(customModel.ReportType != ReportType.Empty) {
                var dataComponentCreator = new DataComponentCreator();
                dataSource = dataComponentCreator.CreateDataComponent(model);
                dataMember = dataSource.DataMember;
            }
            var builder = new DevExpress.Xpf.Reports.UserDesigner.ReportWizard.ReportBuilder(dataSource, dataMember);

            report = new XtraReport();
            report.PaperKind = customModel.PaperKind;
            report.Margins = customModel.PageMargins;
            builder.Build(report, customModel);
            return true;
        }
    }
}

Visual Basic
Imports DevExpress.DataAccess
Imports DevExpress.DataAccess.Wizard
Imports DevExpress.DataAccess.Wizard.Model
Imports DevExpress.Xpf.DataAccess.DataSourceWizard
Imports DevExpress.Xpf.Reports.UserDesigner.ReportWizard
Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraReports.Wizards
Imports DevExpress.XtraReports.Wizards.Presenters
Imports System
Imports System.Collections.Generic
Imports System.Drawing.Printing
Imports System.Linq
Imports System.Text
Imports System.Threading.Tasks

Namespace CustomReportWizard
    Friend Class WizardCustomizationService
        Implements IWizardCustomizationService

        Private Sub IDataSourceWizardCustomizationService_CustomizeDataSourceWizard(ByVal customization As DataSourceWizardCustomizationModel, ByVal container As ViewModelSourceIntegrityContainer) Implements IDataSourceWizardCustomizationService.CustomizeDataSourceWizard
        End Sub

        Private Sub IWizardCustomizationService_CustomizeReportWizard(ByVal customization As ReportWizardCustomizationModel, ByVal container As ViewModelSourceIntegrityContainer) Implements IWizardCustomizationService.CustomizeReportWizard
            customization.Model = New CustomReportModel()
            container.RegisterType(Of ChoosePageSettingsPage(Of CustomReportModel))()
            container.RegisterType(Of ChooseReportTypePage(Of XtraReportModel), CustomChooseReportTypePage)()
            container.RegisterViewModel(Of IChoosePageSettingsPageView, ChoosePageSettingsPageViewModel)()
        End Sub

        Private Function IDataSourceWizardCustomizationService_TryCreateDataSource(ByVal model As IDataSourceModel, ByRef dataSource As Object, ByRef dataMember As String) As Boolean Implements IDataSourceWizardCustomizationService.TryCreateDataSource
            dataSource = Nothing
            dataMember = Nothing
            Return False
        End Function

        Private Function IWizardCustomizationService_TryCreateReport(ByVal model As XtraReportModel, ByRef report As XtraReport) As Boolean Implements IWizardCustomizationService.TryCreateReport
            Dim customModel = TryCast(model, CustomReportModel)
            If customModel Is Nothing OrElse model.ReportType = ReportType.Template OrElse model.ReportType = ReportType.Label Then
                report = Nothing
                Return False
            End If
            Dim dataSource As IDataComponent = Nothing
            Dim dataMember As String = Nothing
            If customModel.ReportType <> ReportType.Empty Then
                Dim dataComponentCreator = New DataComponentCreator()
                dataSource = dataComponentCreator.CreateDataComponent(model)
                dataMember = dataSource.DataMember
            End If
            Dim builder = New DevExpress.Xpf.Reports.UserDesigner.ReportWizard.ReportBuilder(dataSource, dataMember)

            report = New XtraReport()
            report.PaperKind = customModel.PaperKind
            report.Margins = customModel.PageMargins
            builder.Build(report, customModel)
            Return True
        End Function
    End Class
End Namespace

Pavel K (DevExpress)

last modified a year ago

Modified: January 30, 2024 2:07 PM

Platform: Reporting WPF

Product: Reporting for WPF

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.