ExtractDataSourceConnectionParameters Class

Contains parameters used to establish a connection to an Extract Data Source.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public class ExtractDataSourceConnectionParameters :
    ExtractDataSourceConnectionParametersBase

VB.NET

Public Class ExtractDataSourceConnectionParameters
    Inherits ExtractDataSourceConnectionParametersBase

Remarks

The ExtractDataSourceConnectionParameters contains parameters required for connection to the data extract file.

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

When the ConfigureDataConnection event occurs, the ExtractDataSourceConnectionParameters instance is available as the e.ConnectionParameters property value.

For more information about the data connection parameters, refer to the DataConnectionParametersBase topic.

Example

This code snippet is the ConfigureDataConnection event handler that allows you to specify the extract data source’s file location before the dashboard loads.

View Example: How to set master filter in DashboardViewer

C#

using DevExpress.DashboardCommon;
// ...
dashboardViewer.ConfigureDataConnection += dashboardViewer_ConfigureDataConnection;
// ...
private void dashboardViewer_ConfigureDataConnection(object sender, DashboardConfigureDataConnectionEventArgs e)
{
    ExtractDataSourceConnectionParameters parameters = e.ConnectionParameters as ExtractDataSourceConnectionParameters;
    if (parameters != null)
        parameters.FileName = Path.GetFileName(parameters.FileName);
}

VB.NET

Imports DevExpress.DashboardCommon
' ...
AddHandler dashboardViewer.ConfigureDataConnection, AddressOf dashboardViewer_ConfigureDataConnection
' ...
Private Sub dashboardViewer_ConfigureDataConnection(ByVal sender As Object, ByVal e As DashboardConfigureDataConnectionEventArgs)
    Dim parameters As ExtractDataSourceConnectionParameters = TryCast(e.ConnectionParameters, ExtractDataSourceConnectionParameters)
    If parameters IsNot Nothing Then
        parameters.FileName = Path.GetFileName(parameters.FileName)
    End If
End Sub

Inheritance

Object

DataConnectionParametersBase

ExtractDataSourceConnectionParametersBase

ExtractDataSourceConnectionParameters