DashboardConfigurator.SetConnectionStringsProvider(IDataSourceWizardConnectionStringsStorage) Method

Specifies a provider of data connections that can be used by the Web Dashboard.

Namespace: DevExpress.DashboardWeb

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

NuGet Package: DevExpress.Web.Dashboard.Common

Declaration

C#

public void SetConnectionStringsProvider(
    IDataSourceWizardConnectionStringsStorage storage
)

VB.NET

Public Sub SetConnectionStringsProvider(
    storage As IDataSourceWizardConnectionStringsStorage
)

Parameters

Name	Type	Description
storage	IDataSourceWizardConnectionStringsStorage	A storage that implements the IDataSourceWizardConnectionStringsStorage interface and allows you to save the created JSON data connections.

Remarks

Use the following overload to allow end users to save JSON data connections and create new data sources based on them.

To enable the capability to create new JSON data connections for end users, set the allowCreateNewJsonConnection property to true:

Platform	API
HTML JavaScript	DataSourceWizardExtensionOptions.allowCreateNewJsonConnection
ASP.NET Core	DataSourceWizardOptionBuilder.AllowCreateNewJsonConnection
MVC	DashboardExtensionSettings.AllowCreateNewJsonConnection
Web Forms	ASPxDashboard.AllowCreateNewJsonConnection

Implement the IDataSourceWizardConnectionStringsStorage interface and use the created class instance as a method’s parameter.

C#

using DevExpress.DashboardWeb;
using DevExpress.DataAccess.Web;
using DevExpress.DataAccess.ConnectionParameters;
using System.Linq;
// ...
public void ConfigureServices(IServiceCollection services) {
            services
                .AddMvc()
                .AddDefaultDashboardController((configurator, serviceProvider)  => {
                    configurator.SetConnectionStringsProvider(new ConnectionStringProvider());
                });

            services.AddDevExpressControls();
        }

public class ConnectionStringProvider: IDataSourceWizardConnectionStringsStorage {
    readonly Dictionary<string, DataConnectionParametersBase> storage = new Dictionary<string, DataConnectionParametersBase>();
    public Dictionary<string, string> GetConnectionDescriptions() {

        return storage.ToDictionary(p=>p.Key, p=>p.Key);
    }

    public DataConnectionParametersBase GetDataConnectionParameters(string name) {
        return storage[name];
    }

    public void SaveDataConnectionParameters(string name, DataConnectionParametersBase connectionParameters, bool saveCredentials) {
        storage[name] = connectionParameters;
    }
}

VB.NET

Imports DevExpress.DashboardWeb
Imports DevExpress.DataAccess.Web
Imports DevExpress.DataAccess.ConnectionParameters
Imports System.Linq
' ...
Public Sub ConfigureServices(ByVal services As IServiceCollection)
            services.AddMvc().AddDefaultDashboardController(Function(configurator, serviceProvider) AnonymousMethod1(configurator, serviceProvider))

            services.AddDevExpressControls()
End Sub

        Private Function AnonymousMethod1(ByVal configurator As Object, ByVal serviceProvider As Object) As Boolean
            configurator.SetConnectionStringsProvider(New ConnectionStringProvider())
            Return True
        End Function

Public Class ConnectionStringProvider
    Implements IDataSourceWizardConnectionStringsStorage
    Private ReadOnly storage As New Dictionary(Of String, DataConnectionParametersBase)()
    Public Function GetConnectionDescriptions() As Dictionary(Of String, String)

        Return storage.ToDictionary(Function(p) p.Key, Function(p) p.Key)
    End Function

    Public Function GetDataConnectionParameters(ByVal name As String) As DataConnectionParametersBase
        Return storage(name)
    End Function

    Public Sub SaveDataConnectionParameters(ByVal name As String, ByVal connectionParameters As DataConnectionParametersBase, ByVal saveCredentials As Boolean)
        storage(name) = connectionParameters
    End Sub
End Class

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SetConnectionStringsProvider(IDataSourceWizardConnectionStringsStorage) method.

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#

web-dashboard-how-to-store-json-connections-in-database/CS/DXWebApplication21/Global.asax.cs#L13

DashboardConfigurator.Default.SetConnectionStringsProvider(
  new ConnectionStringsStorage(ConfigurationManager.ConnectionStrings["ConnectionsStorage"].ConnectionString));

mvc-dashboard-how-to-store-connections-in-database/CS/DXWebApplication26/App_Start/DashboardConfig.cs#L15

DashboardConfigurator.Default.SetConnectionStringsProvider(
    new ConnectionStringsStorage(ConfigurationManager.ConnectionStrings["ConnectionsStorage"].ConnectionString));

VB.NET

web-dashboard-how-to-store-json-connections-in-database/VB/DXWebApplication21/Global.asax.vb#L15

DashboardConfigurator.Default.SetConnectionStringsProvider(New ConnectionStringsStorage(ConfigurationManager.ConnectionStrings("ConnectionsStorage").ConnectionString))

mvc-dashboard-how-to-store-connections-in-database/VB/DXWebApplication26/App_Start/DashboardConfig.vb#L17

    DashboardConfigurator.Default.SetConnectionStringsProvider(New ConnectionStringsStorage(ConfigurationManager.ConnectionStrings("ConnectionsStorage").ConnectionString))
End Sub