Back to Devexpress

XRDashboardGauge Class

dashboard-devexpress-dot-dashboardcommon-ef0736da.md

latest3.3 KB
Original Source

XRDashboardGauge Class

A printable gauge in the exported Gauge dashboard item.

Namespace : DevExpress.DashboardCommon

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

NuGet Package : DevExpress.Dashboard.Core

Declaration

csharp
public class XRDashboardGauge :
    XRPanel
vb
Public Class XRDashboardGauge
    Inherits XRPanel

Remarks

When you handle the IDashboardControl.CustomExport event, call the CustomExportEventArgs.GetPrintableControls/CustomExportEventArgs.GetPrintableControl(String) method to get XRGaugeDashboardItem that is a printable control corresponding to a Gauge item. Use the XRGaugeDashboardItem.Gauges property to get printable gauges (a collection of the XRDashboardGauge objects).

The following image illustrates elements of the printable gauge:

The following code snippet illustrates how to get XRGaugeDashboardItem and customize printable gauges.

csharp
foreach(KeyValuePair<string, XRControl> printableControl in e.GetPrintableControls()) {
    XRGaugeDashboardItem xrGaugeDashboardItem = printableControl.Value as XRGaugeDashboardItem;
    if(xrGaugeDashboardItem != null) {
        foreach(XRDashboardGauge xrDashboardGauge in xrGaugeDashboardItem.Gauges) {
            xrDashboardGauge.MainSeriesLabel.ForeColor = Color.Red;
            xrDashboardGauge.SecondarySeriesLabel.ForeColor = Color.Red;
        }
    }
 }
vb
For Each printableControl As KeyValuePair(Of String, XRControl) In e.GetPrintableControls()
    Dim xrGaugeDashboardItem As XRGaugeDashboardItem = TryCast(printableControl.Value, XRGaugeDashboardItem)
    If xrGaugeDashboardItem IsNot Nothing Then
        For Each xrDashboardGauge As XRDashboardGauge In xrGaugeDashboardItem.Gauges
            xrDashboardGauge.MainSeriesLabel.ForeColor = Color.Red
            xrDashboardGauge.SecondarySeriesLabel.ForeColor = Color.Red
        Next xrDashboardGauge
    End If
 Next printableControl

Inheritance

Object MarshalByRefObject Component XRControl XRPanel XRDashboardGauge

See Also

XRDashboardGauge Members

DevExpress.DashboardCommon Namespace