Remove Data Providers from the Report Wizard

• Oct 06, 2023
• 3 minutes to read

This example illustrates how to remove some of the data providers available on the Specify a Connection String wizard page.

The following image illustrates this wizard page with all the data providers removed except for Microsoft SQL Server.

Use one of the following approaches to customize the Data Source and Report wizard pages.

Customize the Wizard at Design Time

To customize the Data Source and Report wizard pages at design time in the Visual Studio, drop the StandardReportDesigner or RibbonReportDesigner control on a form and select the XRDesignMdiController component.

In the Properties window, expand the XRDesignMdiController.SqlWizardSettings property and select the required data providers in the SqlWizardSettings.AvailableDataProviders property editor.

Customize the Wizard in Code

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

1. Add a custom service implementing the IWizardCustomizationService interface.

   The following codes removes the Select the Data Source Type wizard page by enabling only the DataSourceType.Xpo setting (corresponding to the Database Connection option).

   Then, the CustomizeProviders<TModel> method is called which assigns a custom list of data providers to a corresponding ISqlDataSourceModel object.

   C#

   using DevExpress.DataAccess.Native.Sql.ConnectionStrategies;
   using DevExpress.DataAccess.UI.Wizard;
   using DevExpress.DataAccess.Wizard.Model;
   using DevExpress.DataAccess.Wizard.Presenters;
   using DevExpress.XtraReports.Wizards;
   using DevExpress.XtraReports.Wizards.Presenters;
   using System.Collections.Generic;
   using System.ComponentModel.Design;
   // ...
   
   class MyWizardCustomizationService : IWizardCustomizationService {
       #region Implementation of IWizardCustomizationService
   
       void IWizardCustomizationService.CustomizeReportWizard(IWizardCustomization<XtraReportModel> tool) {
           if (tool.StartPage == typeof(ChooseReportTypePage<XtraReportModel>)) {
               tool.Model.ReportType = ReportType.Standard;
               tool.Model.DataSourceType = DataSourceType.Xpo;
               tool.StartPage = typeof(ConnectionPropertiesPage<XtraReportModel>);
           }
           CustomizeProviders(tool);
       }
   
       void IWizardCustomizationService.CustomizeDataSourceWizard(IWizardCustomization<XtraReportModel> tool) {
           if (tool.StartPage == typeof(ChooseDataSourceTypePage<XtraReportModel>)) {
               tool.Model.DataSourceType = DataSourceType.Xpo;
               tool.StartPage = typeof(ConnectionPropertiesPage<XtraReportModel>);
           }
           CustomizeProviders(tool);
       }
   
       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;
       }
   
       #endregion
   
       static void CustomizeProviders<TModel>(IWizardCustomization<TModel> tool) where TModel : ISqlDataSourceModel {
           List<ProviderLookupItem> providers = (List<ProviderLookupItem>)tool.Resolve(typeof(List<ProviderLookupItem>));
           providers.RemoveAll((ProviderLookupItem x) => x.ProviderKey != "MSSqlServer");
       }
   }
   

   VB.NET

   Imports DevExpress.DataAccess.Native.Sql.ConnectionStrategies
   Imports DevExpress.DataAccess.UI.Wizard
   Imports DevExpress.DataAccess.Wizard.Model
   Imports DevExpress.DataAccess.Wizard.Presenters
   Imports DevExpress.XtraReports.Wizards
   Imports DevExpress.XtraReports.Wizards.Presenters
   Imports System.Collections.Generic
   Imports System.ComponentModel.Design
   ' ...
   
   Friend Class MyWizardCustomizationService
       Implements IWizardCustomizationService
   
       #Region "Implementation of IWizardCustomizationService"
   
       Private Sub IWizardCustomizationService_CustomizeReportWizard(ByVal tool As IWizardCustomization(Of XtraReportModel)) _ 
           Implements IWizardCustomizationService.CustomizeReportWizard
           If tool.StartPage Is GetType(ChooseReportTypePage(Of XtraReportModel)) Then
               tool.Model.ReportType = ReportType.Standard
               tool.Model.DataSourceType = DataSourceType.Xpo
               tool.StartPage = GetType(ConnectionPropertiesPage(Of XtraReportModel))
           End If
           CustomizeProviders(tool)
       End Sub
   
       Private Sub IWizardCustomizationService_CustomizeDataSourceWizard(ByVal tool As IWizardCustomization(Of XtraReportModel)) _ 
           Implements IWizardCustomizationService.CustomizeDataSourceWizard
           If tool.StartPage Is GetType(ChooseDataSourceTypePage(Of XtraReportModel)) Then
               tool.Model.DataSourceType = DataSourceType.Xpo
               tool.StartPage = GetType(ConnectionPropertiesPage(Of XtraReportModel))
           End If
           CustomizeProviders(tool)
       End Sub
   
       Private Function IWizardCustomizationService_TryCreateDataSource(ByVal 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(ByVal designerHost As IDesignerHost, ByVal model As XtraReportModel, ByVal dataSource As Object, ByVal dataMember As String) As Boolean _ 
           Implements IWizardCustomizationService.TryCreateReport
           Return False
       End Function
   
       #End Region
   
       Private Shared Sub CustomizeProviders(Of TModel As ISqlDataSourceModel)(ByVal tool As IWizardCustomization(Of TModel))
           Dim providers As List(Of ProviderLookupItem) = CType(tool.Resolve(GetType(List(Of ProviderLookupItem))), List(Of ProviderLookupItem))
           providers.RemoveAll(Function(x As ProviderLookupItem) x.ProviderKey <> "MSSqlServer")
       End Sub
   End Class
   

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

   C#

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

   VB.NET

   Imports DevExpress.XtraReports.Wizards
   ' ...
   
   Namespace WindowsFormsApplication1 
       Partial Public Class frmDesigner
           Inherits Form
   
           Public Sub New()
               InitializeComponent()
               reportDesignerMDIController.AddService(GetType(IWizardCustomizationService), New MyWizardCustomizationService())
               AddHandler Load, AddressOf FrmDesigner_Load
           End Sub
   
           Private Sub FrmDesigner_Load(ByVal sender As Object, ByVal e As System.EventArgs)
               reportDesignerMDIController.CreateNewReportWizard()
           End Sub
       End Class
   End Namespace