ExcelDataSourceConnectionParameters Class

Contains parameters used to establish a connection to an Excel workbook or CSV file.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v21.2.Core.dll

Declaration

C#

public class ExcelDataSourceConnectionParameters :
    FileConnectionParametersBase

VB.NET

Public Class ExcelDataSourceConnectionParameters
    Inherits FileConnectionParametersBase

Remarks

The ExcelDataSourceConnectionParameters class instances provide parameters used to establish a connection to an Excel workbook or CSV file: the path to the file (FileConnectionParametersBase.FileName) and password (FileConnectionParametersBase.Password).

For more information about the use of classes that provide data connection parameters, see DataConnectionParametersBase.

You can pass connection parameters when you handle the ConfigureDataConnection event:

• Web - ASPxDashboard.ConfigureDataConnection
• Web - DashboardConfigurator.ConfigureDataConnection
• Web - Dashboard.ConfigureDataConnection
• WinForms - DashboardDesigner.ConfigureDataConnection
• WinForms - DashboardViewer.ConfigureDataConnection
• WPF - DashboardControl.ConfigureDataConnection

Related GitHub Examples

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

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#

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

if (e.ConnectionName == "xlsSales") {
    ExcelDataSourceConnectionParameters excelParams = new ExcelDataSourceConnectionParameters(HttpContext.Current.Server.MapPath("App_Data/Sales.xlsx"));
    e.ConnectionParameters = excelParams;

winforms-dashboard-save-restore-dashboard-state/CS/WinFormsDashboard_DashboardState/Form1.cs#L98

    if (e.DataSourceName == "SalesPerson")
        ((ExcelDataSourceConnectionParameters)e.ConnectionParameters).FileName = @"Data\SalesPerson.xlsx";
}

winforms-dashboard-custom-command-buttons/CS/CommandButtonForTitleAndCaption/Form1.cs#L55

private void DashboardViewer1_ConfigureDataConnection(object sender, DashboardConfigureDataConnectionEventArgs e)         {
    if (e.ConnectionParameters is ExcelDataSourceConnectionParameters connParams)
        connParams.FileName = "SalesPerson.xlsx";

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

if (e.ConnectionName == "excelDataConnection") {
    var excelParams = new ExcelDataSourceConnectionParameters(HostingEnvironment.MapPath(@"~/App_Data/Sales.xlsx"));
    e.ConnectionParameters = excelParams;

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

if (e.ConnectionName == "excelDataConnection") {
    var excelParams = new ExcelDataSourceConnectionParameters(HostingEnvironment.MapPath(@"~/App_Data/Sales.xlsx"));
    e.ConnectionParameters = excelParams;

VB.NET

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

If e.ConnectionName = "xlsSales" Then
    Dim excelParams As New ExcelDataSourceConnectionParameters(HttpContext.Current.Server.MapPath("App_Data/Sales.xlsx"))
    e.ConnectionParameters = excelParams

winforms-dashboard-save-restore-dashboard-state/VB/WinFormsDashboard_DashboardState/Form1.vb#L75

If e.DataSourceName = "SalesPerson" Then
    CType(e.ConnectionParameters, ExcelDataSourceConnectionParameters).FileName = "Data\SalesPerson.xlsx"
End If

winforms-dashboard-custom-command-buttons/VB/CommandButtonForTitleAndCaption/Form1.vb#L46

Private Sub DashboardViewer1_ConfigureDataConnection(ByVal sender As Object, ByVal e As DashboardConfigureDataConnectionEventArgs)
    Dim connParams As ExcelDataSourceConnectionParameters = TryCast(e.ConnectionParameters, ExcelDataSourceConnectionParameters)
    If connParams IsNot Nothing Then

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

If Equals(e.ConnectionName, "excelDataConnection") Then
    Dim excelParams = New ExcelDataSourceConnectionParameters(HostingEnvironment.MapPath("~/App_Data/Sales.xlsx"))
    e.ConnectionParameters = excelParams

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

If e.ConnectionName = "excelDataConnection" Then
    Dim excelParams = New ExcelDataSourceConnectionParameters(HostingEnvironment.MapPath("~/App_Data/Sales.xlsx"))
    e.ConnectionParameters = excelParams

Inheritance

Object

DataConnectionParametersBase

FileConnectionParametersBase

ExcelDataSourceConnectionParameters