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.v24.2.dll
Declaration
[DefaultValue(DefaultBoolean.Default)]
[XtraSerializableProperty]
public DefaultBoolean AllowHtmlString { get; set; }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 | Return Value |
|---|---|---|
| True | The value is true. |
|
| False | The value is false. |
|
| Default | The value is specified by a global option or a higher-level object. |
|
Property Paths
You can access this nested property as listed below:
| Object Type | Path to AllowHtmlString |
|---|---|
| BaseLayoutItem |
|
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.
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.