DashboardItem.Name Property

Gets or sets the name of the dashboard item, displayed in its caption.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v19.1.Core.dll

Declaration

C#

[DefaultValue(null)]
public string Name { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property Name As String

Property Value

Type	Default	Description
String	*null*	A String that specifies the name of the dashboard item.

Remarks

The Name is displayed in the dashboard item caption. It does not have to be unique.

The ComponentName identifies a dashboard item in a dashboard container. It has to be unique in the dashboard.

Tip

Set the DashboardDesigner.AllowEditComponentName property to true to allow changing the item’s ComponentName in the dashboard designer, as shown in the picture below.

Related GitHub Examples

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

how-to-combine-filter-elements-to-a-group-and-bind-them-to-data-t191632/CS/Dashboard_FilterElements_and_Groups/Form1.cs#L24

ComboBoxDashboardItem comboBox1 = new ComboBoxDashboardItem();
comboBox1.Name = "Browser";
comboBox1.DataSource = dataSource; comboBox1.DataMember = "Statistics";

winforms-dashboard-item-collection-changed-event/CS/Dashboard_ItemCollectionChanged_Example/Form1.cs#L33

{
    if (e.AddedItems.Count == 1 && dBoard.Items.Count(i => i.Name == e.AddedItems[0].Name) > 1)
        AddToLog("Duplicated", e.AddedItems);

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

DashboardTabPage tabPage = TabContainer.CreateTabPage();
tabPage.Name = TargetDashboard.Title.Text;
DashboardLayoutTabPage layoutPage = new DashboardLayoutTabPage(tabPage);

wpf-dashboard-create-datefilterdashboarditem/CS/WpfDateFilterDashboardItemSample/MainWindow.xaml.cs#L51

DashboardItemGroup group = new DashboardItemGroup();
group.Name = "Sales by Date";
return group;

winforms-dashboard-create-datefilterdashboarditem/CS/DateFilterDashboardItemSample/Form1.cs#L48

DashboardItemGroup group = new DashboardItemGroup();
group.Name = "Sales by Date";
return group;

VB.NET

wpf-dashboard-create-datefilterdashboarditem/VB/WpfDateFilterDashboardItemSample/MainWindow.xaml.vb#L50

Dim group As New DashboardItemGroup()
group.Name = "Sales by Date"
Return group

winforms-dashboard-create-datefilterdashboarditem/VB/DateFilterDashboardItemSample/Form1.vb#L47

Dim group As New DashboardItemGroup()
group.Name = "Sales by Date"
Return group

winforms-dashboard-item-collection-changed-event/VB/Dashboard_ItemCollectionChanged_Example/Form1.vb#L30

Dim dBoardItems As IList(Of DashboardItem) = TryCast(dBoard.Items, IList(Of DashboardItem))
If e.AddedItems.Count = 1 AndAlso dBoardItems.LongCount(Function(i) i.Name = e.AddedItems(0).Name) > 1 Then
    AddToLog("Duplicated", e.AddedItems)

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

groupCopy.InteractivityOptions.IsMasterFilter = group.InteractivityOptions.IsMasterFilter
groupCopy.Name = group.Name
groupCopy.ShowCaption = group.ShowCaption

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

Dim listBoxItem As New ListBoxDashboardItem() With {.ComponentName = itemComponentName}
listBoxItem.Name = "Countries"
listBoxItem.DataSource = dataSource