Dashboard.DataSources Property

Gets the collection of dashboard data sources.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

public DataSourceCollection DataSources { get; }

VB.NET

Public ReadOnly Property DataSources As DataSourceCollection

Property Value

Type	Description
DataSourceCollection	A collection of objects implementing the IDashboardDataSource interface.

Remarks

The DataSources property provides access to the collection of the dashboard data sources. You can add the following types of data sources to the DataSources collection.

• DashboardSqlDataSource - an SQL data source.
• DashboardOlapDataSource - an OLAP data source.
• DashboardExcelDataSource - a data source used to extract data from Microsoft Excel workbooks or CSV files.
• DashboardEFDataSource - an Entity Framework data source.
• DashboardObjectDataSource - an object data source.
• DashboardExtractDataSource - an extract data source.

All data-aware dashboard items expose the DataDashboardItem.DataSource property that allows you to specify the required data source for the dashboard item. If you are using the DashboardSqlDataSource and DashboardEFDataSource, set the DataDashboardItem.DataMember property to specify a required data member in a dashboard data source. For instance, for a DashboardSqlDataSource data source, the data member is the name of the query (the SqlQuery.Name property).

When a data source is added or removed from the DataSources collection, the Dashboard.DataSourceCollectionChanged event is fired.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DataSources 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#

winforms-dashboard-designer-merge-dashboards-to-tabs/CS/DashboardMerger/DataSourceMerger.cs#L10

public static void MergeDataSources(DataSourceCollection fromDataSources, DashboardMerger dashboardMerger) {
    DataSourceCollection toDataSources = dashboardMerger.TargetDashboard.DataSources;

winforms-dashboard-designer-bind-a-dashboard-to-a-list-object/CS/Dashboard_BindingToList/Form1.cs#L21

PieDashboardItem pies = new PieDashboardItem();
pies.DataSource = dashboard.DataSources[0];
Dimension salesPersonArgument = new Dimension("SalesPerson");

how-to-apply-filtering-to-a-dashboard-items-data-in-olap-mode-e5148/CS/Dashboard_OlapFiltering/Form1.cs#L13

PivotDashboardItem pivot1 = (PivotDashboardItem)dashboard.Items[0];
DashboardOlapDataSource olapDataSource = (DashboardOlapDataSource)dashboard.DataSources[0];

how-to-customize-a-dashboard-color-scheme-t184002/CS/Dashboard_Coloring/Form1.cs#L16

Dashboard dashboard = new Dashboard(); dashboard.LoadFromXml(@"..\..\Data\Dashboard.xml");
IDashboardDataSource dataSource = dashboard.DataSources["dataSource1"];

how-to-pass-a-dashboard-parameter-to-a-custom-sql-query-in-code-e5120/CS/Dashboard_ParametersAndCustomSQL/Form1.cs#L21

DashboardSqlDataSource dataSource = (DashboardSqlDataSource)dashboard.DataSources[0];
CustomSqlQuery salesPersonQuery = (CustomSqlQuery)dataSource.Queries[0];

VB.NET

winforms-dashboard-designer-merge-dashboards-to-tabs/VB/DashboardMerger/DataSourceMerger.vb#L14

Public Shared Sub MergeDataSources(ByVal fromDataSources As DataSourceCollection, ByVal dashboardMerger As DashboardMerger)
    Dim toDataSources As DataSourceCollection = dashboardMerger.TargetDashboard.DataSources

how-to-customize-a-dashboard-color-scheme-t184002/VB/Dashboard_Coloring/Form1.vb#L19

dashboard.LoadFromXml("..\..\Data\Dashboard.xml")
Dim dataSource As IDashboardDataSource = dashboard.DataSources("dataSource1")

how-to-pass-a-dashboard-parameter-to-a-custom-sql-query-in-code-e5120/VB/Dashboard_ParametersAndCustomSQL/Form1.vb#L22

Dim dataSource As DashboardSqlDataSource = DirectCast(dashboard.DataSources(0), DashboardSqlDataSource)
Dim salesPersonQuery As CustomSqlQuery = CType(dataSource.Queries(0), CustomSqlQuery)

how-to-bind-a-dashboard-to-a-dataset-populated-from-an-xml-file-e4857/VB/Dashboard_DataLoading/Form1.vb#L24

Dim grid1 As New GridDashboardItem()
grid1.DataSource = dashboard.DataSources(0)
grid1.Columns.Add(New GridDimensionColumn(New Dimension("Model")))

how-to-bind-a-dashboard-to-a-sql-database-using-dashboardsqldatasource-e5107/VB/Dashboard_DashboardDataProviders/Form1.vb#L31

Private Sub InitializeDashboardItems()
    Dim sqlDataSource As IDashboardDataSource = dashboardDesigner1.Dashboard.DataSources(0)