ExtractDataSourceConnectionParameters Class
Contains parameters used to establish a connection to an Extract Data Source.
Namespace: DevExpress.DashboardCommon
Assembly: DevExpress.Dashboard.v24.2.Core.dll
NuGet Package: DevExpress.Dashboard.Core
#Declaration
public class ExtractDataSourceConnectionParameters :
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.
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);
}