DataItem.UniqueId Property

Gets or sets the unique data item identifier.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

public string UniqueId { get; set; }

VB.NET

Public Property UniqueId As String

Property Value

Type	Description
String	A String that specifies the data item identifier.

Remarks

The UniqueId property returns null for the newly created data item. If you add the created DataItem to a data-bound dashboard item (DataDashboardItem), the UniqueId will return an auto-generated identifier (DataIem0, DataItem1, etc.), which is unique inside a dashboard item.

You can use the value returned by the UniqueId property to identify the data item in the following cases:

• to refer to the specified data item in filter criteria, pass its identifier to the DataDashboardItem.FilterString property;
• to refer to the specified data item in the Expression format condition, pass its identifier to the FormatConditionExpression.Expression property.

Important

If you specified a custom data item identifier, make sure that its value is unique inside a dashboard item. Otherwise, DuplicateDataItemIdException will be thrown.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the UniqueId 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-pass-a-dashboard-parameter-to-a-filter-string-in-code-e5117/CS/Dashboard_Parameters/Form1.cs#L14

PieDashboardItem pie = (PieDashboardItem)dashboard.Items[1];
((GridDimensionColumn)grid.Columns[0]).Dimension.UniqueId = "categoryColumn";
pie.SeriesDimensions[0].UniqueId = "categorySeries";

how-to-usedashboard-parameters-with-the-expressionformat-condition-t260065/CS/Dashboard_ConditionalFormatting_Grid/Form1.cs#L11

GridMeasureColumn extendedPrice = (GridMeasureColumn)grid.Columns[1];
extendedPrice.Measure.UniqueId = "extendedPrice";