DashboardDesigner.DataSourceWizardCustomizationService Property

Provides the capability to customize the Data Source wizard used to create new data sources.

Namespace: DevExpress.DashboardWin

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

Declaration

C#

[Browsable(false)]
public IDataSourceWizardCustomizationService DataSourceWizardCustomizationService { get; set; }

VB.NET

<Browsable(False)>
Public Property DataSourceWizardCustomizationService As IDataSourceWizardCustomizationService

Property Value

Type	Description
IDataSourceWizardCustomizationService	An object implementing the IDataSourceWizardCustomizationService interface.

Remarks

The DataSourceWizardCustomizationService property allows you to customize pages of the Data Source wizard. To learn more, see How to Customize Views and Presenters Corresponding to Wizard Pages.

Example

This example shows 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.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-designer-how-to-customize-the-data-source-wizard-for-the-olap-data-source-t487352.

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;
        }
    }
}

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DataSourceWizardCustomizationService property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-designer-how-to-customize-the-data-source-wizard-for-the-olap-data-source-t487352/CS/DataSourceWizardCustomization/Form1.cs#L13

dashboardDesigner1.CreateRibbon();
dashboardDesigner1.DataSourceWizardCustomizationService = new DataSourceWizardCustomizationService();
dashboardDesigner1.ShowDataSourceWizard();

VB.NET

winforms-designer-how-to-customize-the-data-source-wizard-for-the-olap-data-source-t487352/VB/DataSourceWizardCustomization/Form1.vb#L15

dashboardDesigner1.CreateRibbon()
dashboardDesigner1.DataSourceWizardCustomizationService = New DataSourceWizardCustomizationService()
dashboardDesigner1.ShowDataSourceWizard()