ASPxDashboard.SetConnectionStringsProvider(IDataSourceWizardConnectionStringsStorage) Method

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

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v24.2.Web.WebForms.dll

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 ASPxDashboard.AllowCreateNewJsonConnection property to true.

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 partial class Default : System.Web.UI.Page {
    protected void Page_Load(object sender, EventArgs e) {
      // ...
      ASPxDashboard1.AllowCreateNewJsonConnection = true;
      ASPxDashboard1.SetConnectionStringsProvider(new ConnectionStringProvider());
    }
}
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
' ...

Partial Public Class [Default]
    Inherits System.Web.UI.Page
    Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
      ' ...
      ASPxDashboard1.AllowCreateNewJsonConnection = True
      ASPxDashboard1.SetConnectionStringsProvider(New ConnectionStringProvider())
    End Sub
End Class
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