Skip to main content

BaseLayoutItemOptionsToolTip.IconAllowHtmlString Property

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

Namespace: DevExpress.XtraLayout

Assembly: DevExpress.XtraLayout.v22.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

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

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
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:

Show 14 property paths
Object Type Path to IconAllowHtmlString
LayoutViewCard
.OptionsToolTip.IconAllowHtmlString
LayoutViewField
.OptionsToolTip.IconAllowHtmlString
BaseLayoutItem
.OptionsToolTip.IconAllowHtmlString
EmptySpaceItem
.OptionsToolTip.IconAllowHtmlString
LayoutControlGroup
.OptionsToolTip.IconAllowHtmlString
LayoutControlItem
.OptionsToolTip.IconAllowHtmlString
LayoutGroup
.OptionsToolTip.IconAllowHtmlString
LayoutItem
.OptionsToolTip.IconAllowHtmlString
LayoutItemContainer
.OptionsToolTip.IconAllowHtmlString
LayoutRepositoryItem
.OptionsToolTip.IconAllowHtmlString
SimpleLabelItem
.OptionsToolTip.IconAllowHtmlString
SplitterItem
.OptionsToolTip.IconAllowHtmlString
TabbedControlGroup
.OptionsToolTip.IconAllowHtmlString
TabbedGroup
.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.

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

The figure below shows the result.

BaseLayoutItemOptionsToolTip_IconAllowHtmlString

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.

See Also