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.v20.2.dll

Declaration

[XtraSerializableProperty]
[DefaultValue(DefaultBoolean.Default)]
public DefaultBoolean AllowHtmlString { get; set; }
<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

Corresponds to a Boolean value of true.

False

Corresponds to a Boolean value of false.

Default

The value is determined by the current object's parent object setting (e.g., a control setting).

Property Paths

You can access this nested property as listed below:

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

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

The result is shown below.

BaseLayoutItemOptionsToolTip_AllowHtmlString

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