The requested page is not available for the requested platform. You are viewing the content for Default platform.

DashboardItem.ComponentName Property

Gets or sets the component name of the dashboard item.

Namespace: DevExpress.DashboardCommon

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

Declaration

[DefaultValue(null)]
public string ComponentName { get; set; }
<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.

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.

See Also