DashboardItem.CustomProperties Property

Gets custom properties available for the current dashboard item.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public CustomProperties CustomProperties { get; }

VB.NET

Public ReadOnly Property CustomProperties As CustomProperties

Property Value

Type	Description
CustomProperties	A CustomProperties object that provides access to the item’s custom properties.

Remarks

Tip

Documentation: Create Custom Properties

Related GitHub Examples

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

wpf-dashboard-custom-properties/CS/Wpf-Dashboard-Custom-Properties/Modules/ChartItemModule/ChartOptions/ScaleBreak.cs#L16

ChartDashboardItem chartItem = provider.Dashboard.Items[itemName] as ChartDashboardItem;
bool scaleBreakEnabled = System.Convert.ToBoolean(chartItem.CustomProperties[ChartItemModule.ScaleBreakPropertyName]);
return new AutoScaleBreaks() { Enabled = scaleBreakEnabled };

asp-net-mvc-dashboard-custom-properties-sample/CS/AspMvcDashboardCustomPropertiesSample/Export/ChartConstantLinesExtension.cs#L31

if(chartControl != null && chartItem != null) {
    string constantLinesJSON = chartItem.CustomProperties["ConstantLineSettings"];
    if(constantLinesJSON != null) {

asp-net-web-forms-dashboard-custom-properties-sample/CS/WebFormsDashboardCustomPropertiesSample/Export/ChartConstantLinesExtension.cs#L31

if(chartControl != null && chartItem != null) {
    string constantLinesJSON = chartItem.CustomProperties["ConstantLineSettings"];
    if(constantLinesJSON != null) {

web-forms-dashboard-gauge-ranges/CS/Default.aspx.cs#L55

var rangesJSON = gaugeItem.CustomProperties[CustomPropertyName];
var customRanges = JsonConvert.DeserializeObject<List<CustomRange>>(rangesJSON);

VB.NET

wpf-dashboard-custom-properties/VB/Wpf-Dashboard-Custom-Properties/Modules/ChartItemModule/ChartOptions/ScaleBreak.vb#L18

Dim chartItem As ChartDashboardItem = TryCast(provider.Dashboard.Items(itemName), ChartDashboardItem)
Dim scaleBreakEnabled As Boolean = System.Convert.ToBoolean(chartItem.CustomProperties(ChartItemModule.ScaleBreakPropertyName))
Return New AutoScaleBreaks() With {.Enabled = scaleBreakEnabled}

asp-net-web-forms-dashboard-custom-properties-sample/VB/WebFormsDashboardCustomPropertiesSample/Export/ChartConstantLinesExtension.vb#L30

If chartControl IsNot Nothing AndAlso chartItem IsNot Nothing Then
    Dim constantLinesJSON As String = chartItem.CustomProperties("ConstantLineSettings")
    If constantLinesJSON IsNot Nothing Then

Implements

CustomProperties