DashboardExcelDataSource.ConnectionName Property

Specifies the name of the created connection to an Excel data source.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

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 to an Excel data source:

DashboardConfig.cs

using System.Web.Routing;
using DevExpress.DashboardWeb;
using DevExpress.DashboardWeb.Mvc;
using System.Web.Hosting;
using DevExpress.DataAccess.Excel;
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 Excel data source.
            DashboardExcelDataSource excelDataSource = new DashboardExcelDataSource("Excel Data Source");
            excelDataSource.ConnectionName = "Excel Data Source ID";
            excelDataSource.SourceOptions = new ExcelSourceOptions(new ExcelWorksheetSettings("Sheet1"));
            dataSourceStorage.RegisterDataSource("excelDataSource", excelDataSource.SaveToXml());
            DashboardConfigurator.Default.SetDataSourceStorage(dataSourceStorage);
            DashboardConfigurator.Default.ConfigureDataConnection += Configurator_ConfigureDataConnection;
        }
         private static void Configurator_ConfigureDataConnection(object sender, ConfigureDataConnectionWebEventArgs e) {
            if (e.ConnectionName == "Excel Data Source ID") {
                ExcelDataSourceConnectionParameters excelParams = new ExcelDataSourceConnectionParameters(HostingEnvironment.MapPath(@"~/App_Data/Sales.xlsx"));
                e.ConnectionParameters = excelParams;
            }
        }
    }
}

DashboardConfig.vb

Imports System.Web.Routing
Imports DevExpress.DashboardWeb
Imports DevExpress.DashboardWeb.Mvc
Imports System.Web.Hosting
Imports DevExpress.DataAccess.Excel
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 Excel data source.
            Dim excelDataSource As New DashboardExcelDataSource("Excel Data Source")
            excelDataSource.ConnectionName = "Excel Data Source ID"
            excelDataSource.SourceOptions = New ExcelSourceOptions(New ExcelWorksheetSettings("Sheet1"))
            dataSourceStorage.RegisterDataSource("excelDataSource", excelDataSource.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 = "Excel Data Source ID" Then
                Dim excelParams As New ExcelDataSourceConnectionParameters(HostingEnvironment.MapPath("~/App_Data/Sales.xlsx"))
                e.ConnectionParameters = excelParams
            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/ExcelDashboard.aspx.cs#L21

DashboardExcelDataSource excelDataSource = new DashboardExcelDataSource("Excel Data Source");
excelDataSource.ConnectionName = "excelDataConnection";
excelDataSource.SourceOptions = new ExcelSourceOptions(new ExcelWorksheetSettings("Sheet1"));

WebFormsDashboardConfigurator/CS/WebFormsDashboardConfigurator/Global.asax.cs#L29

DashboardExcelDataSource excelDataSource = new DashboardExcelDataSource("Excel Data Source");
excelDataSource.ConnectionName = "xlsSales";
excelDataSource.SourceOptions = new ExcelSourceOptions(new ExcelWorksheetSettings("Sheet1"));

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

DashboardExcelDataSource excelDataSource = new DashboardExcelDataSource("Excel Data Source");
excelDataSource.ConnectionName = "excelDataConnection";
excelDataSource.SourceOptions = new ExcelSourceOptions(new ExcelWorksheetSettings("Sheet1"));

mvc-dashboard-hide-series-legend-click/CS/MvcDashboard/App_Start/DashboardConfig.cs#L35

DashboardExcelDataSource excelDataSource = new DashboardExcelDataSource("Excel Data Source");
excelDataSource.ConnectionName = "xlsSales";
excelDataSource.FileName = HostingEnvironment.MapPath(@"~/App_Data/Sales.xlsx");

aspnet-web-forms-dashboard-data-federation/CS/AspNetWebFormsDataFederation/Default.aspx.cs#L35

DashboardExcelDataSource excelDataSource = new DashboardExcelDataSource("Excel Data Source");
excelDataSource.ConnectionName = "excelSales";
excelDataSource.FileName = HostingEnvironment.MapPath(@"~/App_Data/SalesPerson.xlsx");

VB.NET

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

Dim excelDataSource As DashboardExcelDataSource = New DashboardExcelDataSource("Excel Data Source")
excelDataSource.ConnectionName = "excelDataConnection"
excelDataSource.SourceOptions = New ExcelSourceOptions(New ExcelWorksheetSettings("Sheet1"))

WebFormsDashboardConfigurator/VB/WebFormsDashboardConfigurator/Global.asax.vb#L31

Dim excelDataSource As New DashboardExcelDataSource("Excel Data Source")
excelDataSource.ConnectionName = "xlsSales"
excelDataSource.SourceOptions = New ExcelSourceOptions(New ExcelWorksheetSettings("Sheet1"))

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

Dim excelDataSource As New DashboardExcelDataSource("Excel Data Source")
excelDataSource.ConnectionName = "excelDataConnection"
excelDataSource.SourceOptions = New ExcelSourceOptions(New ExcelWorksheetSettings("Sheet1"))

aspnet-web-forms-dashboard-data-federation/VB/AspNetWebFormsDataFederation/Default.aspx.vb#L30

Dim excelDataSource As DashboardExcelDataSource = New DashboardExcelDataSource("Excel Data Source")
excelDataSource.ConnectionName = "excelSales"
excelDataSource.FileName = HostingEnvironment.MapPath("~/App_Data/SalesPerson.xlsx")

web-forms-dashboard-save-dashboards-title-as-file-name/VB/DXWebApplication2/Default.aspx.vb#L30

Dim excelDataSource As DashboardExcelDataSource = New DashboardExcelDataSource("Excel Data Source")
excelDataSource.ConnectionName = "Excel Data Source Connection Name"
excelDataSource.SourceOptions = New ExcelSourceOptions(New ExcelWorksheetSettings("Sheet1"))