DashboardItem Class

Serves as the base class for dashboard items.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

public abstract class DashboardItem :
    IDashboardComponent,
    IComponent,
    IDisposable,
    ISupportInitialize,
    IChangeService,
    ISupportPrefix,
    ICurrencyCultureNameProvider,
    IFiltersProvider,
    ICustomPropertyProvider

VB.NET

Public MustInherit Class DashboardItem
    Implements IDashboardComponent,
               IComponent,
               IDisposable,
               ISupportInitialize,
               IChangeService,
               ISupportPrefix,
               ICurrencyCultureNameProvider,
               IFiltersProvider,
               ICustomPropertyProvider

Related API Members

The following members accept/return DashboardItem objects:

• CustomExportWebEventArgs.GetDashboardItem(String)
• DashboardDesigner.SelectedDashboardItem
• DashboardItem.CreateCopy()
• DashboardItemGroup.CreateCopy()
• DashboardItemSelectedEventArgs.SelectedDashboardItem
• DashboardLayoutNode.DashboardItem

Remarks

Dashboard items are UI elements used to display data within the Dashboard. The DashboardItem class provides basic functionality for all types of dashboard items. All dashboard items can be divided into the following groups.

• data-aware dashboard items that display data from the dashboard data source (DataDashboardItem class descendants);
• static dashboard items that can display images (for instance, ImageDashboardItem);
• a group / tab container used to arrange dashboard items within a dashboard (DashboardItemGroup/TabContainerDashboardItem).

The Dashboard.Items property provides access to a collection of items within a dashboard, while the DashboardItemGroup.Items allows you to access dashboard items contained within the specified group.

You can identify a specific dashboard item using its component name (the DashboardItem.ComponentName property).

To specify the parent group / tab container for the current dashboard item, use the DashboardItem.ParentContainer property.

Related GitHub Examples

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

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

public class DashboardMerger {
    IList<DashboardItem> newItems = new List<DashboardItem>();
    Dictionary<string, string> dataSourceNamesMap = new Dictionary<string, string>();

wpf-dashboard-viewer-item-tabs/CS/WpfDashboardTabSupportExample/WpfDashboardTabSupportExample/DashboardItemGenerator.cs#L7

{
    public static DashboardItem GenerateCardItem(IDashboardDataSource dataSource, string itemComponentName) {
        CardDashboardItem cardItem = new CardDashboardItem() {ComponentName= itemComponentName};

winforms-dashboard-window-calculation-example/CS/WindowCalculationExample/TabPageLoadHelper.cs#L50

IEnumerable<DashboardItem> itemsAndGroups = originalDashboard.Items.Union(originalDashboard.Groups).Where(item => !(item is TabContainerDashboardItem));
foreach (DashboardItem item in itemsAndGroups)

winforms-dashboard-viewer-item-tabs/CS/TabSupportExample/DashboardItemGenerator.cs#L12

{
    public static DashboardItem GenerateCardItem(IDashboardDataSource dataSource, string itemComponentName) {
        CardDashboardItem cardItem = new CardDashboardItem() {ComponentName= itemComponentName};

how-to-create-a-dashboard-layout-from-scratch-e5206/CS/Dashboard_LayoutCustomization/Form1.cs#L15

dashboard.LoadFromXml(@"..\..\Data\Dashboard.xml");
DashboardItem grid = (GridDashboardItem)dashboard.Items[0];
DashboardItem chart = (ChartDashboardItem)dashboard.Items[1];

VB.NET

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

'INSTANT VB NOTE: The variable newItems was renamed since Visual Basic does not allow variables and other class members to have the same name:
        Private newItems_Renamed As IList(Of DashboardItem) = New List(Of DashboardItem)()
'INSTANT VB NOTE: The variable dataSourceNamesMap was renamed since Visual Basic does not allow variables and other class members to have the same name:

winforms-dashboard-window-calculation-example/VB/WindowCalculationExample/TabPageLoadHelper.vb#L72

layoutTabContainer.ChildNodes.Add(layoutPage)
Dim itemsAndGroups As IEnumerable(Of DashboardItem) = originalDashboard.Items.Union(originalDashboard.Groups).Where(Function(item) Not(TypeOf item Is TabContainerDashboardItem))
For Each item As DashboardItem In itemsAndGroups

winforms-dashboard-viewer-item-tabs/VB/TabSupportExample/DashboardItemGenerator.vb#L14

Public Shared Function GenerateCardItem(ByVal dataSource As IDashboardDataSource, ByVal itemComponentName As String) As DashboardItem
    Dim cardItem As New CardDashboardItem() With {.ComponentName= itemComponentName}

wpf-dashboard-viewer-item-tabs/VB/WpfDashboardTabSupportExample/WpfDashboardTabSupportExample/DashboardItemGenerator.vb#L7

Public Function GenerateCardItem(ByVal dataSource As IDashboardDataSource, ByVal itemComponentName As String) As DashboardItem
    Dim cardItem As CardDashboardItem = New CardDashboardItem() With {.ComponentName = itemComponentName}

how-to-create-a-dashboard-layout-from-scratch-e5206/VB/Dashboard_LayoutCustomization/Form1.vb#L18

dashboard.LoadFromXml("..\..\Data\Dashboard.xml")
Dim grid As DashboardItem = CType(dashboard.Items(0), GridDashboardItem)
Dim chart As DashboardItem = CType(dashboard.Items(1), ChartDashboardItem)

Implements

ICustomPropertyProvider

Inheritance

Show 34 items

Object

DashboardItem

DashboardItemGroup

DashboardTabPage

DataDashboardItem

ImageDashboardItem

TabContainerDashboardItem

ComboBoxDashboardItem

PieDashboardItem

PieMapDashboardItem

RangeFilterDashboardItem

GridDashboardItem

ScatterChartDashboardItem

PivotDashboardItem

ListBoxDashboardItem

BoundImageDashboardItem

BubbleMapDashboardItem

CardDashboardItem

ChartDashboardItem

ChartDashboardItemBase

ChoroplethMapDashboardItem

CustomDashboardItem

CustomDashboardItem<T>

DateFilterDashboardItem

FilterElementDashboardItem

GaugeDashboardItem

GeoPointMapDashboardItem

GeoPointMapDashboardItemBase

KpiDashboardItem<TKpiElement>

MapDashboardItem

SeriesDashboardItem

TextBoxDashboardItem

TreemapDashboardItem

TreeViewDashboardItem