Remove Data Providers from the Report Wizard

• Sep 28, 2023
• 3 minutes to read

This topic describes how to customize the list of data providers on the Specify Connection Properties wizard page (for instance, display the Microsoft SQL Server option only).

Use one of the following techniques to remove data providers from the Report Wizard.

Removing Data Providers at Design Time

You can customize various Data Source and Report Wizard options at design time using the ReportDesignerBase.DataSourceWizardSettings property. The SqlWizardSettings.AvailableDataProviders property allows you to select which data providers are displayed on the Specify Connection Properties page.

The following XAML code demonstrates how to specify this setting:

XAML

<Window xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:dxrud="http://schemas.devexpress.com/winfx/2008/xaml/reports/userdesigner" 
        xmlns:dxda="http://schemas.devexpress.com/winfx/2008/xaml/dataaccess"
        Title="MainWindow" >
    <dxrud:ReportDesigner DataSourceWizardSettings="{dxda:DataSourceWizardSettings 
            SqlWizardSettings={dxda:SqlWizardSettings AvailableDataProviders=MSSqlServer}}">
    </dxrud:ReportDesigner>
</Window>

Removing Data Providers at Runtime

Do the following to customize the list of data providers at runtime and make the Specify Connection Properties page the Wizard’s first page:

1. Implement the IWizardCustomizationService interface and define the required customization logic in its methods. Remove the Select the Data Source Type page by enabling only the DataSourceType.Xpo setting (corresponding to the Database connection option).

   C#

   using DevExpress.DataAccess.Native.Sql.ConnectionStrategies;
   using DevExpress.DataAccess.Wizard.Model;
   using DevExpress.DataAccess.Wizard.Presenters;
   using DevExpress.Utils.IoC;
   using DevExpress.Xpf.DataAccess.DataSourceWizard;
   using DevExpress.Xpf.Reports.UserDesigner.ReportWizard;
   using DevExpress.Xpf.Reports.UserDesigner.ReportWizard.Pages;
   using DevExpress.XtraReports.UI;
   using DevExpress.XtraReports.Wizards;
   using System.Collections.Generic;
   // ...
   
   namespace WpfApplication1 {
       public class MyWizardCustomizationService : IWizardCustomizationService {
           void IDataSourceWizardCustomizationService.CustomizeDataSourceWizard(DataSourceWizardCustomizationModel customization, 
               ViewModelSourceIntegrityContainer container) {
               if (customization.StartPage == typeof(ChooseDataSourceTypePage<IDataSourceModel>)) {
                   customization.Model.DataSourceType = DataSourceType.Xpo;
                   customization.StartPage = typeof(ConnectionPropertiesPage<IDataSourceModel>);
               }
               CustomizeProviders(container);
           }
   
           void IWizardCustomizationService.CustomizeReportWizard(ReportWizardCustomizationModel customization, 
               ViewModelSourceIntegrityContainer container) {
               if (customization.StartPage == typeof(ChooseReportTypePage)) {
                   customization.Model.ReportType = ReportType.Standard;
                   customization.Model.DataSourceType = DataSourceType.Xpo;
                   customization.StartPage = typeof(ConnectionPropertiesPage<IDataSourceModel>);
               }
               CustomizeProviders(container);
           }
   
           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) {
               report = null;
               return false;
           }
   
           static void CustomizeProviders(IntegrityContainer container) {
               var providers = container.Resolve<List<ProviderLookupItem>>();
               providers.RemoveAll((ProviderLookupItem x) => x.ProviderKey != "MSSqlServer");
           }
       }
   }
   

   VB.NET

   Imports DevExpress.DataAccess.Native.Sql.ConnectionStrategies
   Imports DevExpress.DataAccess.Wizard.Model
   Imports DevExpress.DataAccess.Wizard.Presenters
   Imports DevExpress.Utils.IoC
   Imports DevExpress.Xpf.DataAccess.DataSourceWizard
   Imports DevExpress.Xpf.Reports.UserDesigner.ReportWizard
   Imports DevExpress.Xpf.Reports.UserDesigner.ReportWizard.Pages
   Imports DevExpress.XtraReports.UI
   Imports DevExpress.XtraReports.Wizards
   Imports System.Collections.Generic
   ' ...
   
   Namespace WpfApplication1
       Public Class MyWizardCustomizationService
           Implements IWizardCustomizationService
   
           Private Sub IDataSourceWizardCustomizationService_CustomizeDataSourceWizard(ByVal customization As DataSourceWizardCustomizationModel, _ 
           ByVal container As ViewModelSourceIntegrityContainer) Implements IDataSourceWizardCustomizationService.CustomizeDataSourceWizard
               If customization.StartPage Is GetType(ChooseDataSourceTypePage(Of IDataSourceModel)) Then
                   customization.Model.DataSourceType = DataSourceType.Xpo
                   customization.StartPage = GetType(ConnectionPropertiesPage(Of IDataSourceModel))
               End If
               CustomizeProviders(container)
           End Sub
   
           Private Sub IWizardCustomizationService_CustomizeReportWizard(ByVal customization As ReportWizardCustomizationModel, _ 
           ByVal container As ViewModelSourceIntegrityContainer) Implements IWizardCustomizationService.CustomizeReportWizard
               If customization.StartPage Is GetType(ChooseReportTypePage) Then
                   customization.Model.ReportType = ReportType.Standard
                   customization.Model.DataSourceType = DataSourceType.Xpo
                   customization.StartPage = GetType(ConnectionPropertiesPage(Of IDataSourceModel))
               End If
               CustomizeProviders(container)
           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
               report = Nothing
               Return False
           End Function
   
           Private Shared Sub CustomizeProviders(ByVal container As IntegrityContainer)
               Dim providers = container.Resolve(Of List(Of ProviderLookupItem))()
               providers.RemoveAll(Function(x As ProviderLookupItem) x.ProviderKey <> "MSSqlServer")
           End Sub
       End Class
   End Namespace
   

2. To apply the changes, assign your custom IWizardCustomizationService implementation to the ReportDesignerBase.ServicesRegistry property as follows:

   XAML

   <dxrud:ReportDesigner x:Name="reportDesigner">
       <dxrud:ReportDesigner.ServicesRegistry>
           <dxda:TypeEntry ServiceType="{x:Type dxrudw:IWizardCustomizationService}" ConcreteType="{x:Type local:MyWizardCustomizationService}" />
       </dxrud:ReportDesigner.ServicesRegistry>
   </dxrud:ReportDesigner>