Back to Devexpress

XtraBaseArgs.AllowHtmlText Property

windowsforms-devexpress-dot-xtraeditors-dot-xtrabaseargs-f12e519d.md

latest3.0 KB
Original Source

XtraBaseArgs.AllowHtmlText Property

Gets or sets whether the shown object supports HTML-inspired Text Formatting.

Namespace : DevExpress.XtraEditors

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
public DefaultBoolean AllowHtmlText { get; set; }
vb
Public Property AllowHtmlText As DefaultBoolean

Property Value

TypeDescription
DefaultBoolean

Specifies whether HTML tags are accepted.

|

Available values:

NameDescriptionReturn Value
True

The value is true.

|

0

| | False |

The value is false.

|

1

| | Default |

The value is specified by a global option or a higher-level object.

|

2

|

Remarks

Example 1

The code below uses HTML tags to format the XtraMessageBox caption and content texts.

csharp
XtraMessageBoxArgs xma = new XtraMessageBoxArgs();
xma.Caption = "<b><color=green>Greed Bold Title</color></b>";
xma.Text = "<color=red><size=+4>Increased red content text</size></color>";
xma.AllowHtmlText = DevExpress.Utils.DefaultBoolean.True;
XtraMessageBox.Show(xma);
vb
Dim xma As New XtraMessageBoxArgs()
xma.Caption = "<b><color=green>Greed Bold Title</color></b>"
xma.Text = "<color=red><size=+4>Increased red content text</size></color>"
xma.AllowHtmlText = DevExpress.Utils.DefaultBoolean.True
XtraMessageBox.Show(xma)

Example 2

The code below shows how to add an image from Resources:

csharp
XtraMessageBoxArgs args = new XtraMessageBoxArgs();
args.AllowHtmlText = DevExpress.Utils.DefaultBoolean.True;
args.Caption = "Message";
args.Text = "Text<image=#imgResourceName>";
XtraMessageBox.Show(args);
vb
Dim args As New XtraMessageBoxArgs()
args.AllowHtmlText = DevExpress.Utils.DefaultBoolean.True
args.Caption = "Message"
args.Text = "Text<image=#imgResourceName>"
XtraMessageBox.Show(args)

Alternatively, you can use an image from a collection.

See Also

XtraBaseArgs Class

XtraBaseArgs Members

DevExpress.XtraEditors Namespace