DefaultReportDesignerContainer.RegisterDataSourceWizardConfigFileConnectionStringsProvider() Method

Enables the Web Report Designer to use the data source connections specified in the configuration file of the web application.

Namespace: DevExpress.XtraReports.Web.ReportDesigner

Assembly: DevExpress.XtraReports.v23.2.Web.dll

NuGet Package: DevExpress.Web.Reporting.Common

Declaration

C#

public static void RegisterDataSourceWizardConfigFileConnectionStringsProvider()

VB.NET

Public Shared Sub RegisterDataSourceWizardConfigFileConnectionStringsProvider

Remarks

A connection strings provider is used by the Data Source Wizard to obtain available data connections. The following code sample shows how to register the connection strings provider on application startup.

C#

public class Global_asax : System.Web.HttpApplication {
    void Application_Start(object sender, EventArgs e) {
        //...
        // Register a connection strings provider
        DefaultReportDesignerContainer.RegisterDataSourceWizardConfigFileConnectionStringsProvider();
    } 
    //...
}

VB.NET

Public Class Global_asax
    Inherits System.Web.HttpApplication
    Private Sub Application_Start(sender As Object, e As EventArgs)
        '... 
        ' Register a connection strings provider 
    DefaultReportDesignerContainer.RegisterDataSourceWizardConfigFileConnectionStringsProvider()
    End Sub
    '... 
End Class

When the SQL Data Source wizard obtains connection strings from the Web.config file, the serialized report only contains the connection name (and not the connection string itself).

You can register a custom connection string provider and store all the connection parameters or only the connection name with the serialized data source. When the report serialized with connection parameters is passed to the client, these parameters are encrypted by applying the MachineKey algorithm. You can implement a custom data protection mechanism using the ISecureDataConverter or IDataSourceProtectionService interface.

Refer to the following topics for more information on data connection registration processes:

• ASP.NET Web Forms - Register Data Connections
• ASP.NET MVC - Register Data Connections
• ASP.NET Core - Register Data Connections

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the RegisterDataSourceWizardConfigFileConnectionStringsProvider() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

reporting-web-forms-designer-file-management-dialog/CS/T227679/Global.asax.cs#L13

    DevExpress.XtraReports.Web.Extensions.ReportStorageWebExtension.RegisterExtensionGlobal(new FilesystemReportStorageWebExtension(this.Context));
    DevExpress.XtraReports.Web.ReportDesigner.DefaultReportDesignerContainer.RegisterDataSourceWizardConfigFileConnectionStringsProvider();
}

VB.NET

reporting-web-forms-designer-file-management-dialog/VB/T227679/Global.asax.vb#L11

    DevExpress.XtraReports.Web.Extensions.ReportStorageWebExtension.RegisterExtensionGlobal(New FilesystemReportStorageWebExtension(Context))
    DevExpress.XtraReports.Web.ReportDesigner.DefaultReportDesignerContainer.RegisterDataSourceWizardConfigFileConnectionStringsProvider()
End Sub