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.2.Web.dll
NuGet Package: DevExpress.Web.Dashboard.Common
Declaration
public void SetConnectionStringsProvider(
IDataSourceWizardConnectionStringsStorage storage
)
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.
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;
}
}
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.