IDashboardStorage.GetAvailableDashboardsInfo() Method

Gets information about dashboards stored in the current IDashboardStorage.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v21.2.Web.dll

Declaration

C#

IEnumerable<DashboardInfo> GetAvailableDashboardsInfo()

VB.NET

Function GetAvailableDashboardsInfo As IEnumerable(Of DashboardInfo)

Returns

Type	Description
IEnumerable<DashboardInfo>	A collection of DashboardInfo objects that contain information about dashboards stored in the current IDashboardStorage.

Remarks

The code snippet below shows how to get info about dashboards located in the dashboard file storage.

C#

IDashboardStorage storage = new DashboardFileStorage("App_Data\\Dashboards");
var dashboardList = storage.GetAvailableDashboardsInfo();

Related GitHub Examples

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

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.

VB.NET

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

Public Function GetAvailableDashboardsInfo() As IEnumerable(Of DashboardInfo) Implements DevExpress.DashboardWeb.IDashboardStorage.GetAvailableDashboardsInfo
    Dim list As New List(Of DashboardInfo)()

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

aspxdashboard-how-to-implement-server-side-export-t500219/VB/ASPxDashboard_ServerExport/Default.aspx.vb#L19

Dim dashboardIDs As New List(Of String)()
For Each dashboardInfo As DashboardInfo In (DirectCast(fileStorage, IDashboardStorage)).GetAvailableDashboardsInfo()
    dashboardIDs.Add(dashboardInfo.ID)

aspxdashboard-how-to-switch-dashboards-by-clicking-thumbnails-displayed-in-image-slider-t526185/VB/WebApplication18/Default.aspx.vb#L42

Dim storage As New DashboardFileStorage(dashboardsPath)
Dim dashboards = (TryCast(storage, IDashboardStorage)).GetAvailableDashboardsInfo().ToList()

C#

aspxdashboard-how-to-implement-server-side-export-t500219/CS/ASPxDashboard_ServerExport/Default.aspx.cs#L21

List<string> dashboardIDs = new List<string>();
foreach (DashboardInfo dashboardInfo in ((IDashboardStorage)fileStorage).GetAvailableDashboardsInfo())
{

aspxdashboard-how-to-switch-dashboards-by-clicking-thumbnails-displayed-in-image-slider-t526185/CS/WebApplication18/Default.aspx.cs#L40

DashboardFileStorage storage = new DashboardFileStorage(dashboardsPath);
var dashboards = (storage as IDashboardStorage).GetAvailableDashboardsInfo().ToList();

web-dashboard-how-to-switch-between-dashboards-using-the-aspxlistbox-control-t469869/CS/WebApplication31/Default.aspx.cs#L30

void BindListBox() {
    ASPxListBox1.DataSource = DashboardConfigurator.Default.DashboardStorage.GetAvailableDashboardsInfo();
    ASPxListBox1.DataBind();

web-dashboard-show-popup-with-available-dashboards-and-load/CS/WebApp/Default.aspx.cs#L23

void BindListBox() {
    ASPxListBox1.DataSource = DashboardConfigurator.Default.DashboardStorage.GetAvailableDashboardsInfo();
    ASPxListBox1.DataBind();

aspnet-mvc-dashboard-designer-how-to-enable-users-to-download-a-dashboard-xml-definition-t585658/CS/Controllers/HomeController.cs#L27

if(string.IsNullOrEmpty(dashboardId)) {
    IEnumerable<DashboardInfo> dashboards = st.GetAvailableDashboardsInfo();
    dashboardId = ((DashboardInfo)dashboards.ElementAt(0)).ID;