DefaultReportDesignerContainer.RegisterDataSourceWizardMongoDBConnectionStringsProvider<T>() Method

Registers the connection strings provider for custom MongoDB data connection.

Namespace: DevExpress.XtraReports.Web.ReportDesigner

Assembly: DevExpress.XtraReports.v25.1.Web.dll

NuGet Package: DevExpress.Web.Reporting.Common

Declaration

C#

public static void RegisterDataSourceWizardMongoDBConnectionStringsProvider<T>()
    where T : IDataSourceWizardMongoDBConnectionStringsProvider

VB.NET

Public Shared Sub RegisterDataSourceWizardMongoDBConnectionStringsProvider(Of T As IDataSourceWizardMongoDBConnectionStringsProvider)

Type Parameters

Name	Description
T	A custom connection string provider that implements the IDataSourceWizardConnectionStringsProvider interface.

Remarks

Important

Install the MongoDB.Driver NuGet package to work with MongoDB in the Data Source Wizard.

A custom connection strings provider for MongoDB (that implements the IDataSourceWizardMongoDBConnectionStringsProvider interface) defines which data connections are available to users when configuring the report data source using the Data Source Wizard and Report Wizard.

Call the RegisterDataSourceWizardMongoDBConnectionStringsProvider method at application start to register the custom connection strings provider:

C#

public class Global_asax : System.Web.HttpApplication {
    void Application_Start(object sender, EventArgs e) {
        //...
        // Register the custom connection strings provider for MongoDB.
        DefaultReportDesignerContainer.RegisterDataSourceWizardMongoDBConnectionStringsProvider<MyMongoDBConnectionStringsProvider>();
    }
    //...
}

VB.NET

Public Class Global_asax
    Inherits System.Web.HttpApplication
    Private Sub Application_Start(sender As Object, e As EventArgs)
    '...
    ' Register the custom connection strings provider for MongoDB.
    DefaultReportDesignerContainer.RegisterDataSourceWizardMongoDBConnectionStringsProvider(Of MyMongoDBConnectionStringsProvider)()
    End Sub
    '...
End Class

The following code snippet shows a sample IDataSourceWizardMongoDBConnectionStringsProvider implementation:

C#

using DevExpress.DataAccess.ConnectionParameters;
using DevExpress.DataAccess.Native;
using DevExpress.DataAccess.Web;
using System.Collections.Generic;
using System.Linq;

public class MyMongoDBConnectionStringsProvider : IDataSourceWizardMongoDBConnectionStringsProvider {
    public Dictionary<string, string> GetConnectionDescriptions() {
        Dictionary<string, string> connections = AppConfigHelper.GetConnections().Keys.ToDictionary(x => x, x => x);
        connections.Add("MyMongoDBConnection", "MyMongoDBConnection");
        return connections;
    }

    public DataConnectionParametersBase GetDataConnectionParameters(string name) {
        var mongoDBPasswordAuthInfo = new MongoDBPasswordAuthenticationInfo(
            username: "name",
            password: "password",
            authenticationDatabase: "admin"
        );
        if (name == "MyMongoDBConnection") {
            return new MongoDBConnectionParameters(
                hostName: "localhost",
                isSRV: true,
                port: 27017,
                info: mongoDBPasswordAuthInfo
            );
        }
        return AppConfigHelper.LoadConnectionParameters(name);
    }
}

VB.NET

Imports DevExpress.DataAccess.Native
Imports DevExpress.DataAccess.Web
Imports System.Collections.Generic
Imports System.Linq

Public Class MyMongoDBConnectionStringsProvider
    Inherits IDataSourceWizardMongoDBConnectionStringsProvider

    Public Function GetConnectionDescriptions() As Dictionary(Of String, String)
        Dim connections As Dictionary(Of String, String) = AppConfigHelper.GetConnections().Keys.ToDictionary(Function(x) x, Function(x) x)
        connections.Add("MyMongoDBConnection", "MyMongoDBConnection")
        Return connections
    End Function

    Public Function GetDataConnectionParameters(ByVal name As String) As DataConnectionParametersBase
        Dim mongoDBPasswordAuthInfo = New MongoDBPasswordAuthenticationInfo(username:="name", password:="password", authenticationDatabase:="admin")

        If name = "MyMongoDBConnection" Then
            Return New MongoDBConnectionParameters(hostName:="localhost", isSRV:=True, port:=27017, info:=mongoDBPasswordAuthInfo)
        End If

        Return AppConfigHelper.LoadConnectionParameters(name)
    End Function
End Class