IDataSourceWizardCustomizationService Interface

Provides the capability to customize the Data Source wizard.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v24.1.Win.dll

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public interface IDataSourceWizardCustomizationService

VB.NET

Public Interface IDataSourceWizardCustomizationService

Related API Members

The following members return IDataSourceWizardCustomizationService objects:

• DashboardDesigner.DataSourceWizardCustomizationService

Remarks

To perform deep customization of the Data Source wizard pages, you can update corresponding views and presenters (Model-View-Presenter design pattern) by implementing a custom IDataSourceWizardCustomizationService. The DashboardDesigner control exposes the DashboardDesigner.DataSourceWizardCustomizationService property that accepts objects implementing the IDataSourceWizardCustomizationService interface. To learn more, see How to Customize Views and Presenters Corresponding to Wizard Pages.

Example

The following code snippets show how to remove the Connection type option from the Data Source wizard page that allows end-users to specify OLAP connection parameters. To do this, use the DashboardDesigner.DataSourceWizardCustomizationService property.

Form1.vb

Imports DevExpress.DashboardCommon
Imports DevExpress.DashboardCommon.DataSourceWizard
Imports DevExpress.DashboardWin
Imports DevExpress.DashboardWin.DataSourceWizard
Imports DevExpress.DashboardWin.Native
Imports DevExpress.DataAccess.UI.Wizard

Namespace DataSourceWizardCustomization
    Partial Public Class Form1
        Inherits DevExpress.XtraBars.Ribbon.RibbonForm

        Public Sub New()
            InitializeComponent()
            dashboardDesigner1.CreateRibbon()
            dashboardDesigner1.DataSourceWizardCustomizationService = New DataSourceWizardCustomizationService()
            dashboardDesigner1.ShowDataSourceWizard()
        End Sub
    End Class

    Public Class DataSourceWizardCustomizationService
        Implements IDataSourceWizardCustomizationService

        Public Sub CustomizeDataSourceWizard(ByVal customization As IWizardCustomization(Of DashboardDataSourceModel)) _
            Implements IDataSourceWizardCustomizationService.CustomizeDataSourceWizard
            customization.RegisterPageView(Of IConfigureOlapParametersPageView, CustomConfigureOlapParametersPageView)()
        End Sub
    End Class

    Friend Class CustomConfigureOlapParametersPageView
        Inherits ConfigureOlapParametersPageView

        Protected Overrides Function CreateOlapConnectionParametersControl() As OlapConnectionParametersControl
            Return New CustomOlapConnectionParametersControl()
        End Function
    End Class

    Friend Class CustomOlapConnectionParametersControl
        Inherits OlapConnectionParametersControl

        Public Sub New()
            MyBase.New()
            lciConnectionType.Visibility = DevExpress.XtraLayout.Utils.LayoutVisibility.Never
        End Sub
    End Class
End Namespace

Form1.cs

using DevExpress.DashboardCommon;
using DevExpress.DashboardCommon.DataSourceWizard;
using DevExpress.DashboardWin;
using DevExpress.DashboardWin.DataSourceWizard;
using DevExpress.DashboardWin.Native;
using DevExpress.DataAccess.UI.Wizard;

namespace DataSourceWizardCustomization {
    public partial class Form1 : DevExpress.XtraBars.Ribbon.RibbonForm {
        public Form1() {
            InitializeComponent();
            dashboardDesigner1.CreateRibbon();
            dashboardDesigner1.DataSourceWizardCustomizationService = new DataSourceWizardCustomizationService();
            dashboardDesigner1.ShowDataSourceWizard();
        }
    }

    public class DataSourceWizardCustomizationService : IDataSourceWizardCustomizationService {
        public void CustomizeDataSourceWizard(IWizardCustomization<DashboardDataSourceModel> customization) {
            customization.RegisterPageView<IConfigureOlapParametersPageView, CustomConfigureOlapParametersPageView>();
        }
    }

    class CustomConfigureOlapParametersPageView : ConfigureOlapParametersPageView {
        protected override OlapConnectionParametersControl CreateOlapConnectionParametersControl() {
            return new CustomOlapConnectionParametersControl();
        }
    }

    class CustomOlapConnectionParametersControl : OlapConnectionParametersControl {
        public CustomOlapConnectionParametersControl() : base() {
            lciConnectionType.Visibility = DevExpress.XtraLayout.Utils.LayoutVisibility.Never;
        }
    }
}