DashboardInfo Class

Contains information used to identify a dashboard within the dashboard storage.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v22.1.Web.dll

Declaration

C#

public class DashboardInfo

VB.NET

Public Class DashboardInfo

Remarks

The DashboardInfo class exposes the DashboardInfo.Name and DashboardInfo.ID properties that specify the dashboard name and its identifier, respectively.

For instance, you can use the DashboardInfo class to identify dashboards when implementing the IDashboardStorage/IEditableDashboardStorage interfaces.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DashboardInfo class.

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#

mvc-dashboard-custom-storage/CS/MVCDashboardDesigner/DataBaseEditaleDashboardStorage.cs#L64

IEnumerable<DashboardInfo> IDashboardStorage.GetAvailableDashboardsInfo()
{

web-dashboard-custom-dataset-storage/CS/CustomDashboardStorage.cs#L21

// Gets information about dashboards available in a DataSet.
public IEnumerable<DashboardInfo> GetAvailableDashboardsInfo() {
    List<DashboardInfo> dashboardInfos = new List<DashboardInfo>();

web-dashboard-custom-storage/CS/DatabaseEditableDashboardStorage.cs#L53

public IEnumerable<DashboardInfo> GetAvailableDashboardsInfo() {
    List<DashboardInfo> list = new List<DashboardInfo>();

web-dashboard-how-to-use-a-dashboard-title-as-a-file-name-when-saving-dashboards-t597544/CS/WebApplication18/CustomFileStorage.cs#L46

public IEnumerable<DashboardInfo> GetAvailableDashboardsInfo() {
    IEnumerable<string> dashboardsID = Directory.GetFiles().Select(file => Path.GetFileNameWithoutExtension(file.Name)).ToList();

asp-net-web-forms-dashboard-change-default-error-text-callback-error/CS/WebFormsThrowCustomExceptionDashboardErrorToast/WebForm1.aspx.cs#L33

public class CustomDashboardStorage : IDashboardStorage {
    IEnumerable<DashboardInfo> IDashboardStorage.GetAvailableDashboardsInfo() {
        return new[] {

VB.NET

mvc-dashboard-custom-storage/VB/MVCDashboardDesigner/DataBaseEditaleDashboardStorage.vb#L56

Private Function GetAvailableDashboardsInfo() As IEnumerable(Of DashboardInfo) Implements IDashboardStorage.GetAvailableDashboardsInfo

web-dashboard-custom-dataset-storage/VB/CustomDashboardStorage.vb#L23

' Gets information about dashboards available in a DataSet.
Public Function GetAvailableDashboardsInfo() As IEnumerable(Of DashboardInfo) Implements IEditableDashboardStorage.GetAvailableDashboardsInfo
    Dim dashboardInfos As New List(Of DashboardInfo)()

web-dashboard-custom-storage/VB/DatabaseEditableDashboardStorage.vb#L56

Private Function GetAvailableDashboardsInfo() As IEnumerable(Of DashboardInfo) Implements IDashboardStorage.GetAvailableDashboardsInfo

web-dashboard-how-to-use-a-dashboard-title-as-a-file-name-when-saving-dashboards-t597544/VB/WebApplication18/CustomFileStorage.vb#L46

Public Function GetAvailableDashboardsInfo() As IEnumerable(Of DashboardInfo) Implements IEditableDashboardStorage.GetAvailableDashboardsInfo
    Dim dashboardsID As IEnumerable(Of String) = Directory.GetFiles().Select(Function(file) Path.GetFileNameWithoutExtension(file.Name)).ToList()

asp-net-web-forms-dashboard-change-default-error-text-callback-error/VB/WebFormsThrowCustomExceptionDashboardErrorToast/WebForm1.aspx.vb#L42

Private Function GetAvailableDashboardsInfo() As IEnumerable(Of DashboardInfo) Implements IDashboardStorage.GetAvailableDashboardsInfo
    Return {New DashboardInfo With {.ID = "Dashboard", .Name = "Dashboard"}}

Inheritance

Object

DashboardInfo