IExtractDataSourceWizardCustomization Interface

Provides the capability to customize the Data Source wizard for the Extract Data Source.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v23.2.Win.dll

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public interface IExtractDataSourceWizardCustomization

VB.NET

Public Interface IExtractDataSourceWizardCustomization

Related API Members

The following members return IExtractDataSourceWizardCustomization objects:

• EditExtractOptionsContext.WizardCustomization

Remarks

To customize the Data Source wizard pages for the Extract Data Source, create an object that implements the IExtractDataSourceWizardCustomization interface and assign it to the WizardCustomization property.

Example

This example demonstrates how to customize the Data Source Wizard pages and invoke a customized Wizard in the DashboardViewer.

The static EditExtractOptions(DashboardExtractDataSource, EditExtractOptionsContext) method invokes the Data Source Wizard.

To customize the Edit extract page, the application uses the approach described in the following document: How to Customize Views and Presenters Corresponding to Wizard Pages.


View Example: How to Customize the Data Source Wizard and Invoke It in the DashboardViewer

C#

private void btn_RunWizard_Click(object sender, EventArgs e) {
    EditExtractOptionsContext optionsContext = new EditExtractOptionsContext(this.GetActiveLookAndFeel(), this, dashboardViewer1.Dashboard.DataSources);
    optionsContext.WizardCustomization = new CustomExtractDataSourceWizardCustomizationService();
    ExtractDataSourceUIHelper.EditExtractOptions(new DashboardExtractDataSource() { FileName = "test.dat" }, optionsContext);
}

VB.NET

Private Sub btn_RunWizard_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btn_RunWizard.Click
    Dim optionsContext As New EditExtractOptionsContext(Me.GetActiveLookAndFeel(), Me, dashboardViewer1.Dashboard.DataSources)
    optionsContext.WizardCustomization = New CustomExtractDataSourceWizardCustomizationService()
    ExtractDataSourceUIHelper.EditExtractOptions(New DashboardExtractDataSource() With {.FileName = "test.dat"}, optionsContext)
End Sub

It implements the IExtractDataSourceWizardCustomization interface in a CustomExtractDataSourceWizardCustomizationService class to register a customized page view:

C#

public class CustomExtractDataSourceWizardCustomizationService : IExtractDataSourceWizardCustomization {
    public void CustomizeDataSourceWizard(IWizardCustomization<ExtractDataSourceModel> customization) {
        customization.RegisterPageView<ICreateExtractDataSourcePageView, CustomConfigureExtractDataSourcePageView>();
    }
}

VB.NET

Public Class CustomExtractDataSourceWizardCustomizationService
    Implements IExtractDataSourceWizardCustomization

    Public Sub CustomizeDataSourceWizard(ByVal customization As IWizardCustomization(Of ExtractDataSourceModel)) Implements IExtractDataSourceWizardCustomization.CustomizeDataSourceWizard
        customization.RegisterPageView(Of ICreateExtractDataSourcePageView, CustomConfigureExtractDataSourcePageView)()
    End Sub

End Class

A customized page view is the CustomConfigureExtractDataSourcePageView class that inherits the CreateExtractDataSourcePageView type:

C#

public class CustomConfigureExtractDataSourcePageView : CreateExtractDataSourcePageView {
    public CustomConfigureExtractDataSourcePageView() : base() {                     
        this.checkEditExistingDataSource.Enabled = false;            
    }

    protected override void OnCheckEditExistingDataSourceCheckedChanged(object sender, EventArgs e) {
        base.OnCheckEditExistingDataSourceCheckedChanged(sender, e);
        TextEditFileName.Enabled = false;
    }
}

VB.NET

Public Class CustomConfigureExtractDataSourcePageView
    Inherits CreateExtractDataSourcePageView

    Public Sub New()
        MyBase.New()
        Me.checkEditExistingDataSource.Enabled = False

    End Sub

    Protected Overrides Sub OnCheckEditExistingDataSourceCheckedChanged(ByVal sender As Object, ByVal e As EventArgs)
        MyBase.OnCheckEditExistingDataSourceCheckedChanged(sender, e)
        TextEditFileName.Enabled = False
    End Sub

End Class