Skip to main content

DashboardItem.ComponentName Property

Gets or sets the component name of the dashboard item.

Namespace: DevExpress.DashboardCommon

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

NuGet Packages: DevExpress.Dashboard.Core, DevExpress.Win.Dashboard.Design


public string ComponentName { get; set; }

Property Value

Type Default Description
String null

A String that specifies the component name of the dashboard item.


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.


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


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


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.

See Also