Back to Devexpress

DashboardItem.CustomProperties Property

dashboard-devexpress-dot-dashboardcommon-dot-dashboarditem-35d4f28a.md

latest6.4 KB
Original Source

DashboardItem.CustomProperties Property

Gets custom properties available for the current dashboard item.

Namespace : DevExpress.DashboardCommon

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

NuGet Package : DevExpress.Dashboard.Core

Declaration

csharp
public CustomProperties CustomProperties { get; }
vb
Public ReadOnly Property CustomProperties As CustomProperties

Property Value

TypeDescription
CustomProperties

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

|

Remarks

Tip

Documentation : Create Custom Properties

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.

winforms-dashboard-display-each-series-in-separate-pane-for-chart-items/CS/MultiPaneExtension/MultiPaneModule.cs#L87

csharp
if (xrChart == null ) return;
MultiPaneSettings settings = MultiPaneSettings.FromJson(chartItem.CustomProperties[customPropertyName]);
CustomizeDiagram(xrChart.Diagram as XYDiagram, xrChart.Series, settings);

dashboard-constant-lines/CS/ConstantLineExtension.WPF/ConstantLinesConverter.cs#L24

csharp
DashboardItem chartItem = provider.Dashboard.Items[itemName];
string constantLinesJSON = chartItem.CustomProperties[ConstantLineModule.CustomPropertyName];

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

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

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

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

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

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

winforms-dashboard-display-each-series-in-separate-pane-for-chart-items/VB/MultiPaneExtension/MultiPaneModule.vb#L85

vb
End If
Dim settings As MultiPaneSettings = MultiPaneSettings.FromJson(chartItem.CustomProperties(customPropertyName))
CustomizeDiagram(TryCast(xrChart.Diagram, XYDiagram), xrChart.Series, settings)

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

vb
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

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

Implements

CustomProperties

See Also

Create Custom Properties

Display Custom Properties

DashboardItem Class

DashboardItem Members

DevExpress.DashboardCommon Namespace