DashboardDesigner.DashboardItemElementCustomColor Event

Allows you to color the required dashboard item elements using the specified colors.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v24.1.Win.dll

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public event DashboardItemElementCustomColorEventHandler DashboardItemElementCustomColor

VB.NET

Public Event DashboardItemElementCustomColor As DashboardItemElementCustomColorEventHandler

Event Data

The DashboardItemElementCustomColor event's data class is DashboardItemElementCustomColorEventArgs. The following properties provide information specific to this event:

Property	Description
Color	Gets or sets the color of the dashboard item element.
DashboardItemName	Gets the component name of the dashboard item for which the event was raised.
Data	Gets multidimensional data displayed in the dashboard item.
Measures	Gets measures corresponding to the current dashboard item element.
TargetElement	Gets the axis point tuple corresponding to the current dashboard item element.

Remarks

The DashboardItemElementCustomColor event allows you to color the required dashboard item elements (for instance, chart series points, pie segments or scatter chart points) using the specified colors. The DashboardItemElementCustomColorEventArgs class exposes the following settings that allow you to color the required element.

• Use the DashboardItemElementCustomColorEventArgs.DashboardItemName property to obtain the component name of the dashboard item for which the event was raised.

• The DashboardItemElementCustomColorEventArgs.TargetElement property returns the axis point tuple that corresponds to the current dashboard item element. Use the AxisPointTuple.Equals method to compare the required axis point tuple with the current AxisPointTuple.

  The DashboardItemElementCustomColorEventArgs.Measures property returns measures corresponding to the current dashboard item element. Use the DashboardItemElementCustomColorEventArgs.Data property to create the required tuple (using the MultiDimensionalData.CreateTuple method) and to obtain dashboard item measures (using the MultiDimensionalData.GetMeasures method).

• Use the DashboardItemElementCustomColorEventArgs.Color property to set the color of the current dashboard item element.

Note

By default, the Chart dashboard item colors lines (or fills areas) for the Line/Area series types using the color of the first series point. For these lines/areas, the DashboardItemElementCustomColorEventArgs.TargetElement property returns a tuple that does not contain the AxisPoint on the DashboardDataAxisNames.ChartArgumentAxis.

Important

Note that color modifications applied using the DashboardItemElementCustomColor event are not applied in the resulting exported document.

Implements

DashboardItemElementCustomColor