Remove Data Source Types from the Report Wizard

• Aug 18, 2023
• 2 minutes to read

This example illustrates how to remove certain of the data source types available on the Select the Data Source Type wizard page.

The following image illustrates this wizard page with the Excel File and Object Binding options removed.

To customize the Data Source and Report wizard pages, do the following.

1. Add a custom service implementing the IWizardCustomizationService interface.

   C#

   using DevExpress.DataAccess.UI.Wizard;
   using DevExpress.DataAccess.Wizard.Model;
   using DevExpress.DataAccess.Wizard.Services;
   using DevExpress.XtraReports.Wizards;
   using System.ComponentModel.Design;
   // ...
   
   class WizardCustomizationService : IWizardCustomizationService {
       void IWizardCustomizationService.CustomizeReportWizard(IWizardCustomization<XtraReportModel> tool) {
           DataSourceTypes dataSourceTypes = tool.Resolve(typeof(DataSourceTypes)) as DataSourceTypes;
           dataSourceTypes.Remove(DataSourceType.Excel);
           dataSourceTypes.Remove(DataSourceType.Object);
       }
   
       void IWizardCustomizationService.CustomizeDataSourceWizard(IWizardCustomization<XtraReportModel> tool) {
           DataSourceTypes dataSourceTypes = tool.Resolve(typeof(DataSourceTypes)) as DataSourceTypes;
           dataSourceTypes.Remove(DataSourceType.Excel);
           dataSourceTypes.Remove(DataSourceType.Object);
       }
   
       bool IWizardCustomizationService.TryCreateDataSource(IDataSourceModel model, out object dataSource, out string dataMember) {
           dataSource = null;
           dataMember = null;
           return false;
       }
   
       bool IWizardCustomizationService.TryCreateReport(IDesignerHost designerHost, XtraReportModel model, object dataSource, string dataMember) {
           return false;
       }
   }
   

   VB.NET

   Imports DevExpress.DataAccess.UI.Wizard
   Imports DevExpress.DataAccess.Wizard.Model
   Imports DevExpress.DataAccess.Wizard.Services
   Imports DevExpress.XtraReports.Wizards
   Imports System.ComponentModel.Design
   ' ...
   
   Public Class WizardCustomizationService
       Implements IWizardCustomizationService
       Private Sub IWizardCustomizationService_CustomizeReportWizard(tool As IWizardCustomization(Of XtraReportModel)) _
           Implements IWizardCustomizationService.CustomizeReportWizard
           Dim dataSourceTypes As DataSourceTypes = TryCast(tool.Resolve(GetType(DataSourceTypes)), DataSourceTypes)
           dataSourceTypes.Remove(DataSourceType.Excel)
           dataSourceTypes.Remove(DataSourceType.Object)
       End Sub
   
       Private Sub IWizardCustomizationService_CustomizeDataSourceWizard(tool As IWizardCustomization(Of XtraReportModel)) _
           Implements IWizardCustomizationService.CustomizeDataSourceWizard
           Dim dataSourceTypes As DataSourceTypes = TryCast(tool.Resolve(GetType(DataSourceTypes)), DataSourceTypes)
           dataSourceTypes.Remove(DataSourceType.Excel)
           dataSourceTypes.Remove(DataSourceType.Object)
       End Sub
   
       Private Function IWizardCustomizationService_TryCreateDataSource(model As IDataSourceModel, ByRef dataSource As Object, ByRef dataMember As String) As Boolean _
           Implements IWizardCustomizationService.TryCreateDataSource
           dataSource = Nothing
           dataMember = Nothing
           Return False
       End Function
   
       Private Function IWizardCustomizationService_TryCreateReport(designerHost As IDesignerHost, model As XtraReportModel, dataSource As Object, dataMember As String) As Boolean _
           Implements IWizardCustomizationService.TryCreateReport
           Return False
       End Function
   End Class
   

2. Register the created service by calling the XRDesignMdiController.AddService method.

   C#

   using DevExpress.XtraReports.Wizards;
   // ...
   
   namespace WindowsFormsApplication1 {
       public partial class Form1 : System.Windows.Forms.Form {
           public Form1() {
               InitializeComponent();
               reportDesigner1.AddService(typeof(IWizardCustomizationService), new WizardCustomizationService());
               Load += Form1_Load;
           }
   
           void Form1_Load(object sender, System.EventArgs e) {
               reportDesigner1.CreateNewReportWizard();
           }
       }
   }
   

   VB.NET

   Imports DevExpress.XtraReports.Wizards
   ' ...
   
   Public Class Form1
       Inherits System.Windows.Forms.Form
   
       Public Sub New()
           InitializeComponent()
           ReportDesigner1.AddService(GetType(IWizardCustomizationService), New WizardCustomizationService())
           AddHandler Load, AddressOf Form1_Load
       End Sub
   
       Private Sub Form1_Load(sender As Object, e As EventArgs)
           ReportDesigner1.CreateNewReportWizard()
       End Sub
   End Class