ASPxDashboardViewer.DashboardSource Property

Gets or sets a dashboard supplier for the ASPxDashboardViewer.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v18.2.Web.WebForms.dll

Declaration

C#

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

VB.NET

<DefaultValue("")>
Public Property DashboardSource As Object

Property Value

Type	Default	Description
Object	String.Empty	A Object value specifying a dashboard supplier for the ASPxDashboardViewer.

Remarks

There are two ways to provide a dashboard to be opened in the ASPxDashboardViewer 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#

   ASPxDashboardViewer1.DashboardSource = @"App_Data/Dashboard.xml";
   

   VB.NET

   ASPxDashboardViewer1.DashboardSource = "App_Data/Dashboard.xml"
   

2. Using a dashboard created at design time.

   Assign the type of this dashboard to the DashboardSource property…

   C#

   ASPxDashboardViewer1.DashboardSource = typeof(Dashboard1);
   

   VB.NET

   ASPxDashboardViewer1.DashboardSource = GetType(Dashboard1)
   

   …or use the string containing the dashboard class name.

   C#

   ASPxDashboardViewer1.DashboardSource = "WebApplication1.Dashboard1";
   

   VB.NET

   ASPxDashboardViewer1.DashboardSource = "WebApplication1.Dashboard1"
   

   Important

   Note that specifying the dashboard source using the string containing the dashboard class name is not supported at the Medium Trust permission level.

If necessary, you can load a dashboard at runtime by handling the ASPxDashboardViewer.DashboardLoading event. This event is raised when the ASPxDashboardViewer.DashboardId property is specified. Note that the DashboardSource property is ignored in this case.