BaseControl.SuperTip Property

Gets or sets a SuperToolTip for the current control.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("ToolTip")]
public virtual SuperToolTip SuperTip { get; set; }

VB.NET

<DXCategory("ToolTip")>
Public Overridable Property SuperTip As SuperToolTip

Property Value

Type	Description
SuperToolTip	A SuperToolTip object associated with the control.

Remarks

DevExpress controls support regular and super tooltips. If the ShowToolTips option is enabled, tooltips are shown when the mouse pointer hovers over the control.

Use the following properties to specify a regular tooltip’s content:

• ToolTip — A regular tooltip’s text. If the text is not specified, the tooltip is not displayed even if the title is specified. You can use line breaks in regular tooltips. Use the AllowHtmlTextInToolTip property to specify whether to parse HTML tags in the text. HTML tags allow you to format the text: size, style, hyperlinks, etc.
• ToolTipTitle — A regular tooltip’s title. If the title is not specified, it is not displayed.

• ToolTipIconType — A regular tooltip’s predefined icon. Use the controller’s IconSize property to specify the image size.

  

  To display a custom image in all regular tooltips, use the controller’s ImageList and ImageIndex properties.

  To display a custom image in a specific regular tooltip, handle the BeforeShow event. Use the ImageOptions event argument to assign a raster or vector image to the processed tooltip.

Use the SuperTip property to assign a super tooltip to a control. Enable the AllowHtmlText property to use HTML tags in the super tooltip.

To replace regular tooltips with super tooltips, set the ToolTipController.ToolTipType property to SuperTip. The controller automatically converts regular tooltips to super tooltips. To access this property, you can use the DefaultToolTipController component or a custom controller assigned to the ToolTipController property. See the following topic for more information: Hints and Tooltips.

Example

This example shows how to create a super tooltip with a hyperlink and assign it to a SimpleButton.

The button’s SuperTip property allows you to specify a super tooltip. Use the ToolTipController.AllowHtmlText, SuperToolTip.AllowHtmlText, or ToolTipItem.AllowHtmlText property to enable HTML tags. Handle the ToolTipController.HyperlinkClick event to respond to a click on the hyperlink.

The SuperToolTip Editor allows you to create super tooltips in the designer. To invoke the editor, click the SuperTip property’s ellipsis button in the Properties window.

If you create a tooltip in the designer, you still need to handle the HyperlinkClick event in code. Use the Properties window to assign an event handler.

The example below shows how to create a super tooltip in code.

C#

using DevExpress.Utils;
using System.Diagnostics;

private void Form1_Load(object sender, EventArgs e) {
    // Access the controller that manages tooltips for all controls:
    ToolTipController defaultTooltipController = DevExpress.Utils.ToolTipController.DefaultController;

    // Create and customize a SuperToolTip:
    SuperToolTip sTooltip = new SuperToolTip();
    SuperToolTipSetupArgs args = new SuperToolTipSetupArgs();
    args.Title.Text = "Header";
    args.Contents.Text = "This tooltip contains a hyperlink. Visit the <href=http://help.devexpress.com>DevExpress Knowledge Center</href> to learn more.";
    args.ShowFooterSeparator = true;
    args.Footer.Text = "Footer";
    sTooltip.Setup(args);
    // Enable HTML Text Formatting for the created SuperToolTip:
    sTooltip.AllowHtmlText = DefaultBoolean.True;
    //..or enable this feature for all tooltips:
    //defaultTooltipController.AllowHtmlText = true;

    // Respond to clicking hyperlinks in tooltips:
    defaultTooltipController.HyperlinkClick += defaultTooltipController_HyperlinkClick;

    // Assign a SuperToolTip to the button:
    simpleButton1.SuperTip = sTooltip;
}

void defaultTooltipController_HyperlinkClick(object sender, HyperlinkClickEventArgs e) {
    Process process = new Process();
    process.StartInfo.FileName = (e.Link);
    process.StartInfo.Verb = "open";
    process.StartInfo.WindowStyle = ProcessWindowStyle.Normal;
    try {
        process.Start();
    }
    catch { }
}

VB.NET

Imports DevExpress.Utils

Private Sub Form1_Load(sender As Object, e As EventArgs) Handles MyBase.Load
    ' Access the controller that manages tooltips for all controls:
    Dim defaultTooltipController As ToolTipController = DevExpress.Utils.ToolTipController.DefaultController

    ' Create and customize a SuperToolTip:
    Dim sTooltip As New SuperToolTip()
    Dim args As New SuperToolTipSetupArgs()
    args.Title.Text = "Header"
    args.Contents.Text = "This tooltip contains a hyperlink. Visit the <href=http://help.devexpress.com>DevExpress Knowledge Center</href> to learn more."
    args.ShowFooterSeparator = True
    args.Footer.Text = "Footer"
    sTooltip.Setup(args)
    ' Enable HTML Text Formatting for the created SuperToolTip:
    sTooltip.AllowHtmlText = DefaultBoolean.[True]
    '..or enable this feature for all tooltips:
    'defaultTooltipController.AllowHtmlText = True

    ' Respond to clicking hyperlinks in tooltips:
    AddHandler defaultTooltipController.HyperlinkClick, AddressOf defaultTooltipController_HyperlinkClick

    ' Assign a SuperToolTip to the button:
    SimpleButton1.SuperTip = sTooltip
End Sub

Private Sub defaultTooltipController_HyperlinkClick(sender As Object, e As HyperlinkClickEventArgs)
    Dim process As New Process()
    process.StartInfo.FileName = (e.Link)
    process.StartInfo.Verb = "open"
    process.StartInfo.WindowStyle = ProcessWindowStyle.Normal
    Try
        process.Start()
    Catch
    End Try
End Sub