BaseControl.AllowHtmlTextInToolTip Property

Gets or sets whether HTML formatting is allowed in the control’s regular tooltips.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v21.2.dll

NuGet Packages: DevExpress.Win.Design, DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(DefaultBoolean.Default)]
[DXCategory("ToolTip")]
public virtual DefaultBoolean AllowHtmlTextInToolTip { get; set; }

VB.NET

<DXCategory("ToolTip")>
<DefaultValue(DefaultBoolean.Default)>
Public Overridable Property AllowHtmlTextInToolTip As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	Default	True, to enable HTML formatting in regular tooltips; False, to disable; Default, to use the ToolTipController.AllowHtmlText 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.

Remarks

Use the following properties to enable HTML tags in tooltips:

• ToolTipController.AllowHtmlText — for all regular and super tooltips managed by this controller.
• BaseControl.AllowHtmlTextInToolTip — overrides the controller’s setting for a regular tooltip assigned to this control. To specify the tooltip’s content, use the BaseControl.ToolTip property.
• SuperToolTip.AllowHtmlText — overrides the controller’s setting for a particular super tooltip. To assign a super tooltip to a control, use the BaseControl.SuperTip property.
• ToolTipItem.AllowHtmlText — overrides the previous setting for a particular item (area) in a super tooltip. To specify the item’s content, use the ToolTipItem.Text property.