IConnectionStorageService Interface

When implemented by a class, provides a service functionality to store the data connection settings in WinForms applications.

Namespace: DevExpress.DataAccess.Wizard.Services

Assembly: DevExpress.DataAccess.v18.1.dll

Declaration

C#

public interface IConnectionStorageService

VB.NET

Public Interface IConnectionStorageService

Related API Members

The following members accept/return IConnectionStorageService objects:

Library	Related API Members
Cross-Platform Class Library	ConfigureConnectionContext.ConnectionStorageService
	ConfigureContext.ConnectionStorageService
	EditConnectionContext.ConnectionStorageService
	EditFiltersContext.ConnectionStorageService
WinForms Controls	ConfigureConnectionContext.ConnectionStorageService
	ConfigureContext.ConnectionStorageService
	EditConnectionContext.ConnectionStorageService
	EditFiltersContext.ConnectionStorageService

Remarks

By default, the report connections list is populated based on the connections stored in the application configuration file. You can also use the IConnectionStorageService interface to initialize, save and restore the connection strings in the End-User Report Designer.

For a code sample, see the following example online: WinForms End-User Designer - How to customize the data source wizard connection string storage.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the IConnectionStorageService interface.

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-end-user-designer-how-to-customize-the-data-source-wizard-connection-string-stora-t119350/CS/T119350/CustomConnectionStorageService.cs#L16

namespace T119350 {
    class CustomConnectionStorageService : IConnectionStorageService {
        #region Implementation of IConnectionStorageService

how-to-define-iconnectionstorageservice-filtering-unnecessary-connections-from-appconfig-t281449/CS/WizardConnectionStorageService/Form1.cs#L27

dashboardDesigner1.ServiceContainer.RemoveService(typeof(IConnectionStorageService));
dashboardDesigner1.ServiceContainer.AddService(typeof(IConnectionStorageService), new CustomConnectionStorageService(dashboardDesigner1));

how-to-customize-the-new-report-wizard-introduced-in-the-2014-vol1-release-in-the-end-user-t140683/CS/CustomWizardExample/Wizard/Presenters/ChoosePersonsPage.cs#L13

class ChoosePersonsPage : ChooseReportTypePage<XtraReportModel> {
    public ChoosePersonsPage(IChooseReportTypePageView view, IConnectionStorageService connectionStorageService,
        DataSourceTypes dataSourceTypes, IWizardRunnerContext context, ISolutionTypesProvider solutionTypesProvider)

Reporting_wpf-report-designer-how-to-register-a-custom-page-in-the-report-wizard-t600080/CS/CustomReportWizard/CustomChooseReportTypePage.cs#L13

class CustomChooseReportTypePage : ChooseReportTypePage<XtraReportModel> {
    public CustomChooseReportTypePage(IChooseReportTypePageView view, IConnectionStorageService connectionStorageService,
        DataSourceTypes dataSourceTypes, IWizardRunnerContext context, ISolutionTypesProvider solutionTypesProvider) :

how-to-add-a-new-data-source-type-to-the-data-source-wizard-t310160/CS/CustomWizardExample/Wizard/Presenters/CustomChooseDataSourceTypePage.cs#L13

public class CustomChooseDataSourceTypePage : ChooseDataSourceTypePage<DataSourceModel> {
    public CustomChooseDataSourceTypePage(IChooseDataSourceTypePageView view, IWizardRunnerContext context, IConnectionStorageService connectionStorageService, ISolutionTypesProvider solutionTypesProvider, SqlWizardOptions options) : base(view, context, connectionStorageService, solutionTypesProvider, options)
    {

VB.NET

how-to-define-iconnectionstorageservice-filtering-unnecessary-connections-from-appconfig-t281449/VB/WizardConnectionStorageService/Form1.vb#L26

dashboardDesigner1.ServiceContainer.RemoveService(GetType(IConnectionStorageService))
dashboardDesigner1.ServiceContainer.AddService(GetType(IConnectionStorageService), New CustomConnectionStorageService(dashboardDesigner1))

winforms-end-user-designer-how-to-customize-the-data-source-wizard-connection-string-stora-t119350/VB/T119350/fmDesigner.vb#L15

connectionStorageService = New CustomConnectionStorageService() With {.FileName = "connections.xml", .IncludeApplicationConnections = False}
ReplaceService(Me.reportDesignerMDIController, GetType(IConnectionStorageService), connectionStorageService)
AddHandler reportDesignerMDIController.DesignPanelLoaded, AddressOf DesignMdiControllerOnDesignPanelLoaded

how-to-customize-the-new-report-wizard-introduced-in-the-2014-vol1-release-in-the-end-user-t140683/VB/CustomWizardExample/Wizard/Presenters/ChoosePersonsPage.vb#L15

Public Sub New(ByVal view As IChooseReportTypePageView, ByVal connectionStorageService As IConnectionStorageService, ByVal dataSourceTypes As DataSourceTypes, ByVal context As IWizardRunnerContext, ByVal solutionTypesProvider As ISolutionTypesProvider)
    MyBase.New(view, connectionStorageService, dataSourceTypes, context, solutionTypesProvider)

Reporting_wpf-report-designer-how-to-register-a-custom-page-in-the-report-wizard-t600080/VB/CustomReportWizard/CustomChooseReportTypePage.vb#L18

Public Sub New(ByVal view As IChooseReportTypePageView, ByVal connectionStorageService As IConnectionStorageService, ByVal dataSourceTypes As DataSourceTypes, ByVal context As IWizardRunnerContext, ByVal solutionTypesProvider As ISolutionTypesProvider)
    MyBase.New(view, connectionStorageService, dataSourceTypes, context, solutionTypesProvider)

how-to-add-a-new-data-source-type-to-the-data-source-wizard-t310160/VB/CustomWizardExample/Wizard/Presenters/CustomChooseDataSourceTypePage.vb#L15

Public Sub New(view As IChooseDataSourceTypePageView, context As IWizardRunnerContext, connectionStorageService As IConnectionStorageService, solutionTypesProvider As ISolutionTypesProvider, options As SqlWizardOptions)
    MyBase.New(view, context, connectionStorageService, solutionTypesProvider, options)