Back to Devexpress

IConnectionProviderService.LoadConnection(String) Method

corelibraries-devexpress-dot-dataaccess-dot-wizard-dot-services-dot-iconnectionproviderservice-dot-loadconnection-x28-system-dot-string-x29.md

latest3.8 KB
Original Source

IConnectionProviderService.LoadConnection(String) Method

Loads the specified SqlDataConnection.

Namespace : DevExpress.DataAccess.Wizard.Services

Assembly : DevExpress.DataAccess.v25.2.dll

NuGet Package : DevExpress.DataAccess

Declaration

csharp
SqlDataConnection LoadConnection(
    string connectionName
)
vb
Function LoadConnection(
    connectionName As String
) As SqlDataConnection

Parameters

NameTypeDescription
connectionNameString

A String value, specifying the connection name.

|

Returns

TypeDescription
SqlDataConnection

An SqlDataConnection object.

|

Remarks

The following code shows how to implement the IConnectionProviderService interface:

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

public class CustomConnectionProviderService : IConnectionProviderService {
    public SqlDataConnection LoadConnection(string connectionName) {
        // Specify custom connection parameters.
        return new SqlDataConnection(connectionName, 
            new MsSqlConnectionParameters("localhost", "dataBaseName", "userName", "password", MsSqlAuthorizationType.Windows));
    }
}
vb
Imports DevExpress.DataAccess.ConnectionParameters
Imports DevExpress.DataAccess.Sql
Imports DevExpress.DataAccess.Wizard.Services
' ...

Public Class CustomConnectionProviderService
    Implements IConnectionProviderService
    Public Function LoadConnection(connectionName As String) As SqlDataConnection Implements IConnectionProviderService.LoadConnection
        ' Specify custom connection parameters.
        Return New SqlDataConnection(connectionName, _ 
            New MsSqlConnectionParameters("localhost", "dataBaseName", "userName", "password", MsSqlAuthorizationType.Windows))
    End Function
End Class

The IConnectionProviderService.LoadConnection method is invoked for each connection that is serialized in the report definition file. Use the connectionName parameter to specify connection options and return an SqlDataConnection object.

Use the implemented interface in an application that invokes a report‘s Print Preview or End-User Report Designer :

  • Windows Forms

  • WPF

  • Web Report Viewer and Designer

See Also

IConnectionProviderService Interface

IConnectionProviderService Members

DevExpress.DataAccess.Wizard.Services Namespace