IConnectionProviderService.LoadConnection(String) Method

Returns a connection specified by a name.

Namespace: DevExpress.DataAccess.Wizard.Services

Assembly: DevExpress.DataAccess.v21.1.dll

NuGet Packages: DevExpress.DataAccess, DevExpress.Win.Design

Declaration

C#

SqlDataConnection LoadConnection(
    string connectionName
)

VB.NET

Function LoadConnection(
    connectionName As String
) As SqlDataConnection

Parameters

Name	Type	Description
connectionName	String	A connection name.

Returns

Type	Description
SqlDataConnection	An SqlDataConnection object.

Remarks

The code snippet below implements a service that connects the data source to the MS SQL Server if the connection name is “MyRuntimeConnection”, and creates a connection to the Microsoft SQL Server database file for any other connection name.

C#

using DevExpress.DataAccess.ConnectionParameters;
using DevExpress.DataAccess.Sql;
using DevExpress.DataAccess.Wizard.Services;

class CustomConnectionProviderService : IConnectionProviderService
{
    public SqlDataConnection LoadConnection(string connectionName)
    {
        if (connectionName == "MyRuntimeConnection")
        {
            MsSqlConnectionParameters connectionParameters = new MsSqlConnectionParameters()
            {
                ServerName = "localhost",
                DatabaseName = "NorthWind",
                UserName = null,
                Password = null,
                AuthorizationType = MsSqlAuthorizationType.Windows
            };
            return new SqlDataConnection("MyRuntimeConnection", connectionParameters);
        }
        string connectionString = "XpoProvider=MSSqlServer;Data Source=(LocalDB)\\MSSQLLocalDB;" +
            "AttachDbFilename=|DataDirectory|\\Test.mdf;" +
            "Integrated Security=True;Connect Timeout=30";
        CustomStringConnectionParameters fallbackConnectionParameters =
            new CustomStringConnectionParameters(connectionString);
        return new SqlDataConnection(connectionName, fallbackConnectionParameters);
    }
}

VB.NET

Imports DevExpress.DataAccess.ConnectionParameters
Imports DevExpress.DataAccess.Sql
Imports DevExpress.DataAccess.Wizard.Services

Friend Class CustomConnectionProviderService
    Implements IConnectionProviderService

    Public Function LoadConnection(ByVal connectionName As String) As SqlDataConnection Implements IConnectionProviderService.LoadConnection
        If connectionName = "MyRuntimeConnection" Then
            Dim connectionParameters As New MsSqlConnectionParameters() With
                {.ServerName = "localhost",
                .DatabaseName = "NorthWind",
                .UserName = Nothing,
                .Password = Nothing,
                .AuthorizationType = MsSqlAuthorizationType.Windows}
            Return New SqlDataConnection("MyRuntimeConnection", connectionParameters)
        End If
        Dim connectionString As String = "XpoProvider=MSSqlServer;Data Source=(LocalDB)\MSSQLLocalDB;" _
        & "AttachDbFilename=|DataDirectory|\Test.mdf;" _
        & "Integrated Security=True;Connect Timeout=30"
        Dim fallbackConnectionParameters As New CustomStringConnectionParameters(connectionString)
        Return New SqlDataConnection(connectionName, fallbackConnectionParameters)
    End Function
End Class

The complete code is available in the sample application.

View Example: How to Create a Report Bound to the SQL Data Source