Back to Devexpress

IConnectionProviderService Interface

corelibraries-devexpress-dot-dataaccess-dot-wizard-dot-services.md

latest4.7 KB
Original Source

IConnectionProviderService Interface

If implemented, enables you to restore a data connection on deserializing a report.

Namespace : DevExpress.DataAccess.Wizard.Services

Assembly : DevExpress.DataAccess.v25.2.dll

NuGet Package : DevExpress.DataAccess

Declaration

csharp
public interface IConnectionProviderService
vb
Public Interface IConnectionProviderService

The following members return IConnectionProviderService objects:

LibraryRelated API Members
Cross-Platform Class LibraryIConnectionProviderFactory.Create()
WinForms ControlsConfigureConnectionContext.ConnectionProviderService
EditQueryContext.ConnectionProviderService
ManageRelationsContext.ConnectionProviderService
QueryBuilderEditQueryContext.ConnectionProviderService
RebuildResultSchemaContext.ConnectionProviderService

Remarks

Use the IConnectionProviderService interface to restore the data connections of a report and its child detail report bands.

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 Members

LoadConnection(String)

IConnectionStorageService

RegisterConnectionProviderFactory<T>()

DevExpress.DataAccess.Wizard.Services Namespace