Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

BaseControl.AllowHtmlTextInToolTip Property

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

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.2.dll

NuGet Package: DevExpress.Win.Navigation

#Declaration

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

#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 Return Value
True

The value is true.

0

False

The value is false.

1

Default

The value is specified by a global option or a higher-level object.

2

#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.

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.
}

Allow HTML Tags - WinForms ToolTipController

See Also