ExtractDataSourceUIHelper Class

Allows you to invoke the Data Source Wizard for the ExtractDataSource type.

Namespace: DevExpress.DashboardWin

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

NuGet Packages: DevExpress.Win.Dashboard, DevExpress.WindowsDesktop.Win.Dashboard

Declaration

C#

public static class ExtractDataSourceUIHelper

VB.NET

Public Module ExtractDataSourceUIHelper

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 How to Customize Views and Presenters Corresponding to Wizard Pages document.

C#

EditExtractOptionsContext optionsContext = new EditExtractOptionsContext(this.GetActiveLookAndFeel(), this, dashboardViewer1.Dashboard.DataSources);
optionsContext.WizardCustomization = new CustomExtractDataSourceWizardCustomizationService();
ExtractDataSourceUIHelper.EditExtractOptions(new DashboardExtractDataSource() { FileName = "test.dat" }, optionsContext);   

VB.NET

Dim optionsContext As New EditExtractOptionsContext(Me.GetActiveLookAndFeel(), Me, dashboardViewer1.Dashboard.DataSources)
optionsContext.WizardCustomization = New CustomExtractDataSourceWizardCustomizationService()
ExtractDataSourceUIHelper.EditExtractOptions(New DashboardExtractDataSource() With {.FileName = "test.dat"}, optionsContext)

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))
        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

Note

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

Inheritance

Object

ExtractDataSourceUIHelper