BaseGaugeWin.Labels Property

Provides access to the collection of static labels for the current gauge.

Namespace: DevExpress.XtraGauges.Win.Base

Assembly: DevExpress.XtraGauges.v19.1.Win.dll

Declaration

C#

[DXCategory("Behavior")]
public LabelComponentCollection Labels { get; }

VB.NET

<DXCategory("Behavior")>
Public ReadOnly Property Labels As LabelComponentCollection

Property Value

Type	Description
DevExpress.XtraGauges.Win.Base.LabelComponentCollection	A LabelComponentCollection object that represents the collection of static labels for the current gauge.

Remarks

Use this collection to add, remove or modify static labels for a gauge. See Labels and Images to learn more.

Example

The following code shows how to add a static label (LabelComponent) to a circular gauge. The label displays custom text and formats its appearance using HTML tags.

The result is shown below:

C#

using DevExpress.XtraGauges.Win.Base;
using DevExpress.XtraGauges.Core.Drawing;

circularGauge1.BeginUpdate();
LabelComponent label = new LabelComponent("myLabel");
label.AppearanceText.TextBrush = new SolidBrushObject(Color.Black);
label.Position = new DevExpress.XtraGauges.Core.Base.PointF2D(125, 210);
label.ZOrder = -10000;
label.AllowHTMLString = true;
label.Text = "<color=RED>MPH</color> <b>/</b> <color=BLUE>KM/H</color>";
circularGauge1.Labels.Add(label);
circularGauge1.EndUpdate();

VB.NET

Imports DevExpress.XtraGauges.Win.Base
Imports DevExpress.XtraGauges.Core.Drawing

circularGauge1.BeginUpdate()
Dim label As LabelComponent = New LabelComponent("myLabel")
label.AppearanceText.TextBrush = New SolidBrushObject(Color.Black)
label.Position = New DevExpress.XtraGauges.Core.Base.PointF2D(125, 210)
label.ZOrder = -10000
label.AllowHTMLString = True
label.Text = "<color=RED>MPH</color> <b>/</b> <color=BLUE>KM/H</color>"
circularGauge1.Labels.Add(label)
circularGauge1.EndUpdate()

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Labels 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-add-a-custom-progress-indicator-to-a-snap-application-e5074/CS/CustomProgressIndicator/MyProgressIndicationForm.cs#L15

private new DevExpress.XtraGauges.Win.Gauges.Linear.LinearScaleComponent Scale { get { return this.linearGauge1.Scales[0]; } }
private DevExpress.XtraGauges.Win.Base.LabelComponent Label { get { return linearGauge1.Labels[0]; } }

VB.NET

how-to-add-a-custom-progress-indicator-to-a-snap-application-e5074/VB/CustomProgressIndicator/MyProgressIndicationForm.vb#L25

Get
    Return linearGauge1.Labels(0)
End Get