DashboardViewer.DashboardSource Property

Gets or sets a dashboard supplier for the DashboardViewer.

Namespace: DevExpress.DashboardWin

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

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

[DefaultValue(null)]
public object DashboardSource { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property DashboardSource As Object

Property Value

Type	Default	Description
Object	null	A Object value specifying a dashboard supplier for the DashboardViewer.

Remarks

There are two ways to provide a dashboard to be opened in the DashboardViewer using the DashboardSource property.

1. Using a dashboard XML definition.

   Assign the string containing the absolute or relative path to the dashboard XML file to the DashboardSource property…

   C#

   dashboardViewer1.DashboardSource = @"..\..\Data\Dashboard.xml";
   

   VB.NET

   dashboardViewer1.DashboardSource = "..\..\Data\Dashboard.xml"
   

   …or provide a dashboard XML file using a Uri class instance.

   C#

   dashboardViewer1.DashboardSource = new Uri(@"..\..\Data\Dashboard.xml", UriKind.Relative);
   

   VB.NET

   dashboardViewer1.DashboardSource = New Uri("..\..\Data\Dashboard.xml", UriKind.Relative)
   

2. Using a dashboard created at design time.

   Assign the type of this dashboard to the DashboardSource property…

   C#

   dashboardViewer1.DashboardSource = typeof(Dashboard1);
   

   VB.NET

   dashboardViewer1.DashboardSource = GetType(Dashboard1)
   

   …or use the string containing the dashboard class name.

   C#

   dashboardViewer1.DashboardSource = "WindowsFormsApplication1.Dashboard1";
   

   VB.NET

   dashboardViewer1.DashboardSource = "WindowsFormsApplication1.Dashboard1"
   

Note

If the DashboardDesigner / DashboardViewer control is placed in the MDI child form, load dashboards in the Shown event handler instead of Load.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DashboardSource 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-how-to-manage-dashboard-parameters-in-code/CS/CustomParametersExample/ViewerForm1.cs#L11

dashboardViewer.CustomParameters += DashboardViewer_CustomParameters;
dashboardViewer.DashboardSource = typeof(SampleDashboard);
dashboardViewer.Dashboard.Parameters.Add(CreateParameter());

how-to-display-the-total-value-above-each-pie-chart/CS/TotalsInChartsExample/Form1.cs#L14

    dashboardViewer1.CalculateHiddenTotals = true;
    dashboardViewer1.DashboardSource = typeof(Dashboards.Dashboard1);
}

winforms-viewer-save-and-apply-dashboard-state/CS/WinFormsViewerSaveAndApplyDashboarState/ViewerForm1.cs#L16

    dashboardViewer.SetInitialDashboardState += dashboardViewer_SetInitialDashboardState;
    dashboardViewer.DashboardSource = path;
}

VB.NET

winforms-dashboard-how-to-manage-dashboard-parameters-in-code/VB/CustomParametersExample/ViewerForm1.vb#L14

AddHandler dashboardViewer.CustomParameters, AddressOf DashboardViewer_CustomParameters
dashboardViewer.DashboardSource = GetType(SampleDashboard)
dashboardViewer.Dashboard.Parameters.Add(CreateParameter())

how-to-display-the-total-value-above-each-pie-chart/VB/TotalsInChartsExample/Form1.vb#L14

    dashboardViewer1.CalculateHiddenTotals = True
    dashboardViewer1.DashboardSource = GetType(Dashboards.Dashboard1)
End Sub

winforms-viewer-save-and-apply-dashboard-state/VB/WinFormsViewerSaveAndApplyDashboarState/ViewerForm1.vb#L15

    AddHandler dashboardViewer.SetInitialDashboardState, AddressOf dashboardViewer_SetInitialDashboardState
    dashboardViewer.DashboardSource = path
End Sub