DashboardItem.ComponentName Property

Gets or sets the component name of the dashboard item.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

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

VB.NET

<DefaultValue(Nothing)>
Public Property ComponentName As String

Property Value

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

Remarks

The component name of the dashboard item is used in code to identify the dashboard item object. Use this name when calling the DashboardViewer.SetMasterFilter or DashboardViewer.PerformDrillDown methods.

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. You can use only letters (A-Z, a-z), numbers (0-9), and the underscore symbol (_) to set a component name. The component name should start with a letter.

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 ComponentName 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#

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

DashboardItemGroup groupCopy = CreateGroupCopy(originalGroup);
if(toGroups.Any(g => g.ComponentName == originalGroup.ComponentName)) {
    if(ResolveGroupNamesConflict(groupCopy, originalGroup.ComponentName, toGroups, dashboardMerger.GroupNamesMap))

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

targetDashboard.Items.Add(destinationParentContainer);
TabContainerName = destinationParentContainer.ComponentName;

winforms-dashboard-customize-title-and-item-captions/CS/CustomizeDashboardItemCaptionExample/ViewerForm1.cs#L32

foreach (var item in viewer.Dashboard.Items) {
    if (viewer.CanSetMasterFilter(item.ComponentName)) {
        var filterValues = viewer.GetCurrentFilterValues(item.ComponentName);

xaf-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard/CS/ShowDetailViewFromDashboard.Module.Win/Controllers/WinShowDetailViewFromDashboardController.cs#L30

private bool IsGridDashboardItem(Dashboard dashboard, string dashboardItemName) {
    DashboardItem dashboardItem = dashboard.Items.SingleOrDefault(item => item.ComponentName == dashboardItemName);
    return dashboardItem is GridDashboardItem;

winforms-dashboard-viewer-tab-navigation-buttons-tab-animation/CS/DashboardNextPrevTab/ViewerForm.cs#L62

int increment = value == NextPrevValue.Next ? 1 : -1;
string tabContainerName = tabContainer.ComponentName;
int selectedIndex = dashboardViewer.GetSelectedTabPageIndex(tabContainerName);

VB.NET

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

Dim groupCopy As DashboardItemGroup = CreateGroupCopy(originalGroup)
If toGroups.Any(Function(g) g.ComponentName = originalGroup.ComponentName) Then
    If ResolveGroupNamesConflict(groupCopy, originalGroup.ComponentName, toGroups, dashboardMerger.GroupNamesMap) Then

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

targetDashboard.Items.Add(destinationParentContainer)
TabContainerName = destinationParentContainer.ComponentName
Dim tabPage As DashboardTabPage = CopyDashboardToTabPage(targetDashboard, originalDashboard)

winforms-dashboard-customize-title-and-item-captions/VB/CustomizeDashboardItemCaptionExample/ViewerForm1.vb#L35

For Each item In viewer.Dashboard.Items
    If viewer.CanSetMasterFilter(item.ComponentName) Then
        Dim filterValues = viewer.GetCurrentFilterValues(item.ComponentName)

xaf-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard/VB/ShowDetailViewFromDashboard.Module.Win/Controllers/WinShowDetailViewFromDashboardController.vb#L32

Private Function IsGridDashboardItem(ByVal dashboard As Dashboard, ByVal dashboardItemName As String) As Boolean
    Dim dashboardItem As DashboardItem = dashboard.Items.SingleOrDefault(Function(item) item.ComponentName = dashboardItemName)
    Return TypeOf dashboardItem Is GridDashboardItem

winforms-dashboard-viewer-tab-navigation-buttons-tab-animation/VB/DashboardNextPrevTab/ViewerForm.vb#L66

Dim increment As Integer = If(value = NextPrevValue.Next, 1, -1)
Dim tabContainerName As String = tabContainer.ComponentName
Dim selectedIndex As Integer = dashboardViewer.GetSelectedTabPageIndex(tabContainerName)