IConnectionConfigProvider Interface

Provides the path to the file that stores connection strings.

Namespace: DevExpress.Data.Entity

Assembly: DevExpress.Data.v18.2.dll

Declaration

C#

public interface IConnectionConfigProvider

VB.NET

Public Interface IConnectionConfigProvider

Remarks

Use the IConnectionConfigProvider interface to control from which configuration file to read connection strings for EFDataSource. Implement this interface together with IConnectionStringsProvider and use the AddService function to register it.

Example

The code sample below shows how to use IConnectionConfigProvider to provide a custom configuration file with connection strings. The sample assumes that you have an Entity Framework data model named NorthwindEntities that describes data fields. The code creates a new EFDataSource and assigns it as a data source for XtraReport1.

C#

using DevExpress.Data.Entity;
using DevExpress.DataAccess.EntityFramework;
// ...
    class EFConnectionConfig : IConnectionConfigProvider, IConnectionStringsProvider {
        public IConnectionStringInfo[] GetConfigFileConnections() {
            throw new NotImplementedException();
        }

        public string GetConnectionConfigPath() {
            // Return the path to custom configuration file
            return Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "efConnectionStrings.config"); ;
        }

        public IConnectionStringInfo[] GetConnections() {
            throw new NotImplementedException();
        }

        public string GetConnectionString(string connectionStringName) {
            throw new NotImplementedException();
        }

        public IConnectionStringInfo GetConnectionStringInfo(string connectionStringName) {
            throw new NotImplementedException();
        }
    }
    public class EFConnection {
        public void ConfigureDataSource() {

            // Create a report instance
            var xtraReport1 = new XtraReport1();

            // Create an EFDataSource
            var dataSource = new EFDataSource();

            dataSource.ConnectionParameters = new EFConnectionParameters(typeof(NorthwindEntities));

            // Set the report's data source
            xtraReport1.DataSource = dataSource;

            xtraReport1.DataMember = "Products";

            var reportDesignTool = new ReportDesignTool(xtraReport1);

            // Register the interface as a service
            reportDesignTool.DesignForm.DesignMdiController.AddService(typeof(IConnectionStringsProvider), new EFConnectionConfig());

            reportDesignTool.ShowDesigner();

        }
    }

VB.NET

Imports DevExpress.Data.Entity
Imports DevExpress.DataAccess.EntityFramework
' ...
    Friend Class EFConnectionConfig
        Implements IConnectionConfigProvider, IConnectionStringsProvider

        Public Function GetConfigFileConnections() As IConnectionStringInfo()
            Throw New NotImplementedException()
        End Function

        Public Function GetConnectionConfigPath() As String
            ' Return the path to custom configuration file
            Return Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "efConnectionStrings.config")

        End Function

        Public Function GetConnections() As IConnectionStringInfo()
            Throw New NotImplementedException()
        End Function

        Public Function GetConnectionString(ByVal connectionStringName As String) As String
            Throw New NotImplementedException()
        End Function

        Public Function GetConnectionStringInfo(ByVal connectionStringName As String) As IConnectionStringInfo
            Throw New NotImplementedException()
        End Function
    End Class
    Public Class EFConnection
        Public Sub ConfigureDataSource()

            ' Create a report instance
            Dim xtraReport1 = New XtraReport1()

            ' Create an EFDataSource
            Dim dataSource = New EFDataSource()

            dataSource.ConnectionParameters = New EFConnectionParameters(GetType(NorthwindEntities))

            ' Set the report's data source
            xtraReport1.DataSource = dataSource

            xtraReport1.DataMember = "Products"

            Dim reportDesignTool = New ReportDesignTool(xtraReport1)

            ' Register the interface as a service
            reportDesignTool.DesignForm.DesignMdiController.AddService(GetType(IConnectionStringsProvider), New EFConnectionConfig())

            reportDesignTool.ShowDesigner()

        End Sub
    End Class