BarItem.AllowHtmlText Property

Gets or sets whether the BarItem.Caption and BarItem.Description can be formatted using HTML tags.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v21.2.dll

NuGet Packages: DevExpress.Win.Design, DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(DefaultBoolean.Default)]
[DXCategory("Appearance")]
public virtual DefaultBoolean AllowHtmlText { get; set; }

VB.NET

<DefaultValue(DefaultBoolean.Default)>
<DXCategory("Appearance")>
Public Overridable Property AllowHtmlText As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	Default	A DefaultBoolean value that specifies if HTML tags can be used to format bar item text.

Available values:

Name	Description
True	true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
False	false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
Default	The default behavior determined by the control’s logic.

Remarks

Bar items support BarItem.Caption and BarItem.Description formatting using a set of HTML tags.

You can enable the HTML formatting feature for individual bar items via the BarItem.AllowHtmlText property or for all bar items within a BarManager/RibbonControl via the BarManager.AllowHtmlText/RibbonControl.AllowHtmlText property. If you enable HTML formatting for all bar items, you can still disable the feature for individual bar items by setting the BarItem.AllowHtmlText property to False.

Even if HTML text formatting is disabled for all bar items, you can enable this feature for individual bar items by setting the BarItem.AllowHtmlText property to True.

If the AllowHtmlText property is set to Default, the HTML formatting feature is controlled by the BarManager.AllowHtmlText/RibbonControl.AllowHtmlText property.