IDataSourceWizardConnectionStringsProvider Interface

If implemented, enables managing data connections used by the Data Source Wizard.

Namespace: DevExpress.DataAccess.Web

Assembly: DevExpress.DataAccess.v18.2.dll

Declaration

C#

public interface IDataSourceWizardConnectionStringsProvider

VB.NET

Public Interface IDataSourceWizardConnectionStringsProvider

Remarks

Some DevExpress web components (for instance, the ASP.NET Report Designer and Web Dashboard) provide the capability to connect to SQL databases using the Data Source Wizard. This wizard allows end-users to select one of the predefined data connections, connect to a corresponding database and select the required data. The IDataSourceWizardConnectionStringsProvider interface allows you to implement a provider of connection strings that will be displayed in the Data Source Wizard’ UI.

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

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

Note

Note that IDataSourceWizardConnectionStringsProvider can be used only for SQL data sources. To learn how to supply end-users with data from another data source types, refer to the following topics:

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

Example

This example shows how to implement a custom provider of connection strings by implementing the IDataSourceWizardConnectionStringsProvider interface.

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