IDataSourceWizardConnectionStringsProvider Interface

If implemented, this interface allows you to manage data connections in web components.

Namespace: DevExpress.DataAccess.Web

Assembly: DevExpress.DataAccess.v20.2.dll

NuGet Packages: DevExpress.DataAccess, DevExpress.WindowsDesktop.DataAccess

Declaration

C#

public interface IDataSourceWizardConnectionStringsProvider

VB.NET

Public Interface IDataSourceWizardConnectionStringsProvider

Remarks

In the ASP.NET Report Designer and Web Dashboard components, users can invoke the Data Source Wizard to connect to SQL databases. This wizard allows users to select a predefined data connection, connect to the specified database, and select data.

The IDataSourceWizardConnectionStringsProvider interface allows you to implement a provider of connection strings that should be displayed in the Data Source Wizard’s UI. It also resolves connection parameters for reports that are previewed in the Document Viewer (both standalone and embedded in the Report Designer).

The topics below describe how to implement IDataSourceWizardConnectionStringsProvider for different components.

• ASP.NET Web Forms Report Designer - Register Data Connections
• ASP.NET Web Forms Dashboard Control - Register Default Data Connections
• ASP.NET Core Dashboard Control and ASP.NET MVC Dashboard Extension - Register Default Data Connections

You can use IDataSourceWizardConnectionStringsProvider only with SQL data sources. Refer to the following topics for instructions on how to supply data from other data source types:

• ASP.NET Web Forms Report Designer - Registering Default Data Sources
• ASP.NET Web Forms Dashboard Control - Register Default Data Sources
• ASP.NET Core Dashboard Control and ASP.NET MVC Dashboard Extension - Register Default Data Sources

Example

This example shows how to implement the IDataSourceWizardConnectionStringsProvider interface to create a custom connection string provider.

C#

using DevExpress.DataAccess.ConnectionParameters;
using DevExpress.DataAccess.Native;
using DevExpress.DataAccess.Web;
// ...

    public class MyDataSourceWizardConnectionStringsProvider : IDataSourceWizardConnectionStringsProvider
    {
        public Dictionary<string, string> GetConnectionDescriptions()
        {
            Dictionary<string, string> connections = new Dictionary<string, string>();

            // Customize the loaded connections list.  
            connections.Remove("LocalSqlServer");
            connections.Add("msAccessConnection", "MS Access Connection");
            connections.Add("msSqlConnection", "MS SQL Connection");
            return connections;
        }

        public DataConnectionParametersBase GetDataConnectionParameters(string name)
        {
            // Return custom connection parameters for the custom connection.
            if (name == "msAccessConnection")
            {
                return new Access97ConnectionParameters("|DataDirectory|nwind.mdb", "", "");
            }
            else if (name == "msSqlConnection")
            {
                return new MsSqlConnectionParameters("localhost", "Northwind", "", "", MsSqlAuthorizationType.Windows);
            }
            return AppConfigHelper.LoadConnectionParameters(name);
        }
    }

VB.NET

Imports DevExpress.DataAccess.ConnectionParameters
Imports DevExpress.DataAccess.Native
Imports DevExpress.DataAccess.Web
' ...

    Public Class MyDataSourceWizardConnectionStringsProvider
        Implements IDataSourceWizardConnectionStringsProvider
        Public Function GetConnectionDescriptions() As Dictionary(Of String, String)
            Dim connections As New Dictionary(Of String, String)()

            ' Customize the loaded connections list.  
            connections.Remove("LocalSqlServer")
            connections.Add("msAccessConnection", "MS Access Connection")
            connections.Add("msSqlConnection", "MS SQL Connection")
            Return connections
        End Function

        Public Function GetDataConnectionParameters(ByVal name As String) As DataConnectionParametersBase
            ' Return custom connection parameters for the custom connection.
            If name = "msAccessConnection" Then
                Return New Access97ConnectionParameters("|DataDirectory|nwind.mdb", "", "")
            ElseIf name = "msSqlConnection" Then
                Return New MsSqlConnectionParameters("localhost", "Northwind", "", "", MsSqlAuthorizationType.Windows)
            End If
            Return AppConfigHelper.LoadConnectionParameters(name)
        End Function
    End Class