Label.AllowHTMLString Property

Gets or sets whether HTML tags can be used to format the Label.Text.

Namespace: DevExpress.XtraGauges.Core.Model

Assembly: DevExpress.XtraGauges.v20.1.Core.dll

Declaration

[DefaultValue(false)]
public bool AllowHTMLString { get; set; }
<DefaultValue(False)>
Public Property AllowHTMLString As Boolean

Property Value

Type Default Description
Boolean

false

true if HTML formatting is supported for the label's text; otherwise, false.

Remarks

If the AllowHTMLString property is set to true, you can use HTML tags to format the Label.Text. See HTML Text Formatting, to learn about the supported HTML tags.

Examples

The following example shows how to create a scale value label for a linear gauge. The label will indicate the scale's current value, formatted in a specific manner.

In the example, the label is added via the LinearScale.Labels collection. The result is shown below:

ValueLabel_ex

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

linearScaleComponent1.BeginUpdate();
// Create a label.
ScaleLabel label = new ScaleLabel();
label.Name = "MyLabel";
label.Position = new DevExpress.XtraGauges.Core.Base.PointF2D(160, 125);
label.AppearanceText.TextBrush = new SolidBrushObject("Color:Black");
// Enable HTML formattings and format the label's text via the FormatString property.
label.AllowHTMLString = true;
label.Text = "";
label.FormatString = "T=<b>{1:F0}°</b>";
// Add the label to the scale.
linearScaleComponent1.Labels.Add(label);
linearScaleComponent1.EndUpdate();

Implements

DevExpress.XtraGauges.Core.Model.ILabelEx.AllowHTMLString
See Also