BaseLayoutItemOptionsToolTip.AllowHtmlString Property

Gets or sets whether HTML formatting tags can be used to format the tooltip’s text.

Namespace: DevExpress.XtraLayout

Assembly: DevExpress.XtraLayout.v22.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(DefaultBoolean.Default)]
[XtraSerializableProperty]
public DefaultBoolean AllowHtmlString { get; set; }

VB.NET

<XtraSerializableProperty>
<DefaultValue(DefaultBoolean.Default)>
Public Property AllowHtmlString As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	Default	True if HTML formatting tags can be used to format the tooltip’s text; False if not; Default uses the ToolTipController.AllowHtmlText global setting.

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.

Property Paths

You can access this nested property as listed below:

Object Type	Path to AllowHtmlString
BaseLayoutItem	.OptionsToolTip .AllowHtmlString

Remarks

Use the BaseLayoutItemOptionsToolTip.ToolTip property to provide a tool tip shown when the item’s caption is hovered over with the mouse pointer. The AllowHtmlString property enables HTML formatting in the tooltip. If this property is set to Default, the feature is controlled by the ToolTipController.AllowHtmlText global setting.

The code below enables HTML tags for a particular item, and specifies a formatted tool tip. For the complete list of supported tags, see HTML Text Formatting.

C#

layoutControlGroup2.OptionsToolTip.AllowHtmlString = DevExpress.Utils.DefaultBoolean.True;
layoutControlGroup2.OptionsToolTip.ToolTip = "Enter a <b>valid</b> address";

VB.NET

layoutControlGroup2.OptionsToolTip.AllowHtmlString = DevExpress.Utils.DefaultBoolean.True
layoutControlGroup2.OptionsToolTip.ToolTip = "Enter a <b>valid</b> address"

The result is shown below.

You can also override the HTML formatting setting for a particular item when handling the ToolTipController.BeforeShow event. For this purpose, use the ToolTipControllerShowEventArgs.AllowHtmlText property of the ToolTipControllerShowEventArgs object passed as a parameter to the event handler.