XRLabel.AllowMarkupText Property

Gets or sets whether you can use HTML-style markup tags to format the control’s text.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.1.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

[DefaultValue(false)]
[SRCategory(ReportStringId.CatBehavior)]
public virtual bool AllowMarkupText { get; set; }

VB.NET

<SRCategory(ReportStringId.CatBehavior)>
<DefaultValue(False)>
Public Overridable Property AllowMarkupText As Boolean

Property Value

Type	Default	Description
Boolean	false	true, if the control allows markup text; otherwise, false.

Remarks

If the AllowMarkupText property is set to true, you can use markup tags to format the XRLabel.Text property.

XRLabel supports the following tags:

Tag	End Tag	Supported in XLS / XLSX Export	Supported in DOCX Export	Description
<br>	-			Inserts a single line break. Enable the WordWrap property to use this tag.
<nbsp>	-			Inserts a space.
<color=value> Examples: <color=red> <color=0,255,0> <color=255,0,255,0> <color=#0000FF>	</color>			Specifies the text color.
<backcolor=value> Examples: <backcolor=red> <backcolor=0,255,0> <backcolor=255,0,255,0> <backcolor=#0000FF>	</backcolor>			Specifies the background color.
<size=value> Examples: <size=10> <size=+4> <size=-4>	</size>			Specifies the font size.
<b>	</b>			Defines bold text.
<i>	</i>			Defines italic text.
<r>	</r>			Defines regular text. This resets any bold, italic, underlined, or strikethrough formats specified with tags or applied in the control’s appearance settings.
<s>	</s>			Defines strikethrough text.
<u>	</u>			Defines underlined text.
<sub>	</sub>			Specifies that the text is smaller and displayed lower than the previous character. Export to DOCX does not support nested sub elements. For example, double subscript: 2<sub>2<sub>2</sub></sub>
<sup>	</sup>			Defines that the text is smaller and displayed higher than the previous character. Export to DOCX does not support nested sup elements. For example, double superscript: 2<sup>2<sup>2</sup></sup>
<font> Example: <font='Times New Roman' size=15 color=red>Times New Roman</font>	</font>			Specifies the font family. You can combine it with the color and size settings within a single tag.
<image=value> Examples: <image=UpArrow.png> <image=DownArrow.png;size=20,20>	-			Inserts an image from the report’s named image collection. Supports raster and SVG images. Use the report’s ImageResources property to provide images and reference them by their Id. The image tag’s size attribute sets the image display pixel size. If the specified width/height exceeds the label’s width/height, it is reduced to display the entire image. Specify the size attribute after the tag’s value followed by the “;” character.
<href=value> Example: <href=www.devexpress.com>Our web site</href>	</href>			Displays a hyperlink. The value string specifies the hyperlink source, and the string between the opening and closing tags is the text to display. Note that hyperlinks are not clickable in the documents exported to the E-Mail / HTML format because the label’s markup text is exported as an image. Use the XRRichText control to create an E-Mail / HTML document with clickable hyperlinks.

Note

XRCharacterComb controls do not support HTML-style markup tags. The AllowMarkupText property is not in effect.

Limitations

If the AllowMarkupText property is set to True, the following limitations apply:

• The XRControl.TextAlignment property - the TextAlignment.TopJustify, TextAlignment.MiddleJustify, and TextAlignment.BottomJustify values have no effect.
• The Angle property has no effect.
• The content is exported as an image to the HTML, MHT and RTF formats. To export HTML content as rich text or HTML, use the XRRichTextBox control instead.

Example

The code sample below illustrates how to create a label, format its text and insert an image.

C#

using DevExpress.XtraPrinting.Drawing;
using DevExpress.XtraReports.UI;
using System.Drawing;
// ...
XtraReport report = new XtraReport();
Image image = Image.FromFile("testImage.png");
ImageItem imageItem = new ImageItem("img1", new ImageSource(image));
report.ImageResources.Add(imageItem);

XRLabel label = new XRLabel() {
    AllowMarkupText = true,
    WordWrap = true,
    Text = "Test<br>" + 
        "<size=14>Size = 14<br>" +
        "<b>Bold</b> <i>Italic</i> <u>Underline</u></size><br>" +
        "<size=11>Size = 11<br>" +
        "<color=255,0,0>Sample Text</color></size><br>" +
        "<href=www.devexpress.com>Hyperlink</href><br>" +
        "<image=img1>"
};

DetailBand detailBand = new DetailBand();
detailBand.Controls.Add(label);
report.Bands.Add(detailBand);

VB.NET

Imports DevExpress.XtraPrinting.Drawing
Imports DevExpress.XtraReports.UI
Imports System.Drawing
' ...
Dim report As New XtraReport()
Dim image As Image = System.Drawing.Image.FromFile("testImage.png")
Dim imageItem As New ImageItem("img1", New ImageSource(image))
report.ImageResources.Add(imageItem)

Dim label As New XRLabel() With {
.AllowMarkupText = True, 
.WordWrap = True, 
.Text = "Test<br>" & "<size=14>Size = 14<br>" _ 
& "<b>Bold</b> <i>Italic</i> <u>Underline</u></size><br>" _
& "<size=11>Size = 11<br>" & "<color=255,0,0>Sample Text</color></size><br>" _
& "<href=www.devexpress.com>Hyperlink</href><br>" & "<image=img1>"}

Dim detailBand As New DetailBand()
detailBand.Controls.Add(label)
report.Bands.Add(detailBand)

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AllowMarkupText 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#

snap-convert-snx-to-repx/CS/SnxToRepx/Converter/ParagraphProcessor.cs#L141

//Allow HTML-style markup
label.AllowMarkupText = true;
//Remove borders

VB.NET

snap-convert-snx-to-repx/VB/SnxToRepx/Converter/ParagraphProcessor.vb#L130

'Allow HTML-style markup
label.AllowMarkupText = True
'Remove borders