BaseLayoutItemOptionsToolTip.IconAllowHtmlString Property

Gets or sets whether HTML tags can be used to format the tooltip text displayed for the item’s icon.

Assembly : DevExpress.XtraLayout.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

C#
VB.NET

csharp

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

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

Property Value

Type	Default	Description
DefaultBoolean	Default

True if HTML tags can be used to format the tooltip text; False if not; Default uses the ToolTipController.AllowHtmlText global setting.

Available values:

Name	Description	Return 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

Property Paths

You can access this nested property as listed below:

Object Type	Path to IconAllowHtmlString
BaseLayoutItem

.OptionsToolTip .IconAllowHtmlString

Remarks

Use the BaseLayoutItemOptionsToolTip.IconToolTip property to provide a tool tip shown when the item’s icon is hovered with the mouse pointer. The IconAllowHtmlString setting 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 shows how to enable HTML tags for a particular item, and provide a formatted tool tip. For the complete list of supported HTML tags, see HTML Text Formatting.

C#
VB.NET

csharp

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

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

The figure below shows the result.

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.