DashboardExtractDataSource.ConnectionName Property

Specifies the name of the created connection to an Extract Data Source.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v22.1.Core.dll

Declaration

C#

[DefaultValue(null)]
public string ConnectionName { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property ConnectionName As String

Property Value

Type	Default	Description
String	null	A connection name.

Remarks

Use the ConnectionName property to identify the data source for which the ConfigureDataConnection event is raised.

The following code snippet shows how to configure a data connection for an Extract Data Source:

DashboardConfig.cs

using System.Web.Routing;
using DevExpress.DashboardWeb;
using DevExpress.DashboardWeb.Mvc;
using System.Web.Hosting;
using DevExpress.DashboardCommon;

namespace DashboardMVC {
    public static class DashboardConfig {
        public static void RegisterService(RouteCollection routes) {
            routes.MapDashboardRoute("dashboardControl");

            DashboardFileStorage dashboardFileStorage = new DashboardFileStorage("~/App_Data/Dashboards");
            DashboardConfigurator.Default.SetDashboardStorage(dashboardFileStorage);
            DataSourceInMemoryStorage dataSourceStorage = new DataSourceInMemoryStorage();
            // Registers an Extract Data Source.
            DashboardExtractDataSource extractDataSource = new DashboardExtractDataSource("Extract Data Source");
            extractDataSource.ConnectionName = "Extract Data Source ID";
            dataSourceStorage.RegisterDataSource("extractDataSource", extractDataSource.SaveToXml());
            DashboardConfigurator.Default.SetDataSourceStorage(dataSourceStorage);
            DashboardConfigurator.Default.ConfigureDataConnection += Configurator_ConfigureDataConnection;
        }
         private static void Configurator_ConfigureDataConnection(object sender, ConfigureDataConnectionWebEventArgs e) {
               if (e.ConnectionName == "Extract Data Source ID") {
                ExtractDataSourceConnectionParameters extractParams = new ExtractDataSourceConnectionParameters(HostingEnvironment.MapPath(@"~/App_Data/SalesPersonExtract.dat"));
                e.ConnectionParameters = extractParams;
            }
        }
    }
} 

DashboardConfig.vb

Imports System.Web.Routing
Imports DevExpress.DashboardWeb
Imports DevExpress.DashboardWeb.Mvc
Imports System.Web.Hosting
Imports DevExpress.DashboardCommon

Namespace DashboardMVC
    Public Module DashboardConfig
        Public Sub RegisterService(ByVal routes As RouteCollection)
            routes.MapDashboardRoute("dashboardControl")

            Dim dashboardFileStorage As New DashboardFileStorage("~/App_Data/Dashboards")
            DashboardConfigurator.Default.SetDashboardStorage(dashboardFileStorage)
            Dim dataSourceStorage As New DataSourceInMemoryStorage()
            ' Registers an Extract Data Source.
            Dim extractDataSource As New DashboardExtractDataSource("Extract Data Source")
            extractDataSource.ConnectionName = "Extract Data Source ID"
            dataSourceStorage.RegisterDataSource("extractDataSource", extractDataSource.SaveToXml())
            DashboardConfigurator.Default.SetDataSourceStorage(dataSourceStorage)
            AddHandler DashboardConfigurator.Default.ConfigureDataConnection, AddressOf Configurator_ConfigureDataConnection
        End Sub
         Private Sub Configurator_ConfigureDataConnection(ByVal sender As Object, ByVal e As ConfigureDataConnectionWebEventArgs)
               If e.ConnectionName = "Extract Data Source ID" Then
                Dim extractParams As New ExtractDataSourceConnectionParameters(HostingEnvironment.MapPath("~/App_Data/SalesPersonExtract.dat"))
                e.ConnectionParameters = extractParams
               End If
         End Sub
    End Module
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ConnectionName property.

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#

asp-net-web-forms-dashboard-register-data-sources/CS/WebFormsDashboardDataSources/Pages/ExtractDashboard.aspx.cs#L20

DashboardExtractDataSource extractDataSource = new DashboardExtractDataSource("Extract Data Source");
extractDataSource.ConnectionName = "extractDataConnection";
dataSourceStorage.RegisterDataSource("extractDataSource ", extractDataSource.SaveToXml());

DashboardDifferentUserDataMVC/CS/MVCDashboard/CustomDataSourceStorage.cs#L41

DashboardExtractDataSource extractDataSource = new DashboardExtractDataSource(extractDataSourceId) {
    ConnectionName = "extractSalesPerson"
};

asp-net-mvc-dashboard-register-data-sources/CS/MvcDashboardDataSources/Configuration/ExtractDataSourceConfigurator.cs#L11

extractDataSource.Name = "Extract Data Source";
extractDataSource.ConnectionName = "dataExtract";
storage.RegisterDataSource("extractDataSource ", extractDataSource.SaveToXml());

VB.NET

asp-net-web-forms-dashboard-register-data-sources/VB/WebFormsDashboardDataSources/Pages/ExtractDashboard.aspx.vb#L20

Dim extractDataSource As DashboardExtractDataSource = New DashboardExtractDataSource("Extract Data Source")
extractDataSource.ConnectionName = "extractDataConnection"
dataSourceStorage.RegisterDataSource("extractDataSource ", extractDataSource.SaveToXml())

asp-net-mvc-dashboard-register-data-sources/VB/MvcDashboardDataSources/Configuration/ExtractDataSourceConfigurator.vb#L11

extractDataSource.Name = "Extract Data Source"
extractDataSource.ConnectionName = "dataExtract"
storage.RegisterDataSource("extractDataSource ", extractDataSource.SaveToXml())