ToolTipController.AllowHtmlText Property

Gets or sets whether HTML formatting tags can be used to format text in tooltips.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v24.2.dll

Declaration

C#

[DefaultValue(false)]
[DXCategory("Appearance")]
public bool AllowHtmlText { get; set; }

VB.NET

<DefaultValue(False)>
<DXCategory("Appearance")>
Public Property AllowHtmlText As Boolean

Property Value

Type	Default	Description
Boolean	false	true if HTML tags can be used to format text in tooltips; otherwise, false.

Remarks

Use the following properties to enable HTML tags in tooltips:

• ToolTipController.AllowHtmlText — for all regular and super tooltips managed by this controller. Assign the ToolTipController component to the control’s ToolTipController property.
• BaseControl.AllowHtmlTextInToolTip — overrides the ToolTip 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 ToolTip 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.

Example

This example demonstrates how to enable HTML tags for the SimpleButton and TextEdit controls.

C#

toolTipController1.AllowHtmlText = true;
simpleButton1.ToolTipController = toolTipController1;
textEdit1.ToolTipController = toolTipController1;
simpleButton1.ToolTip = "I\'ve agree to the <href=www.devexpress.com>terms and conditions</href>.<br/>I want to <b>subscribe</b> to the newsletter.";
textEdit1.ToolTip = "Enter your <b>valid</b> e-mail address.";
//...

private void toolTipController1_HyperlinkClick(object sender, HyperlinkClickEventArgs e) {
    // Handle a click on a hyperlink displayed in a tooltip.
}

VB.NET

toolTipController1.AllowHtmlText = True
simpleButton1.ToolTipController = toolTipController1
textEdit1.ToolTipController = toolTipController1
simpleButton1.ToolTip = "I've agree to the <href=www.devexpress.com>terms and conditions</href>.<br/>I want to <b>subscribe</b> to the newsletter."
textEdit1.ToolTip = "Enter your <b>valid</b> e-mail address."
' ...

Private Sub toolTipController1_HyperlinkClick(ByVal sender As Object, ByVal e As HyperlinkClickEventArgs)
    ' Handle a click on a hyperlink displayed in a tooltip.
End Sub