How to: Display a Hyperlink in a Tooltip
- 3 minutes to read
Tooltips can contain hyperlinks.
You can use HTML tags to format the text in tooltips. The <href> and </href> tags allow you to insert a hyperlink.
<href=www.devexpress.com>Our Web Site</href>
To enable the tags, use one of the following properties:
- ToolTipController.AllowHtmlText — for all tooltips in the application
- SuperToolTip.AllowHtmlText — for a specific super tooltip
- ToolTipItem.AllowHtmlText — for a super tooltip’s region
You can also use the AllowHtmlTextInToolTip property to enable HMTL tags for BaseControl descendents: ButtonEdit, LabelControl, SimpleButton, etc.
Handle the ToolTipController.HyperlinkClick event to respond to a click on a hyperlink.
Example: Display a Hyperlink in a Super Tooltip
The code below shows how to create a super tooltip with a hyperlink and assign it to a button.
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 { }
}
Create a Tooltip with a Hyperlink in the Editor
If you create a tooltip in the editor, use the dedicated option to enable HTML tags.
Use the Properties window to assign a ToolTipController.HyperlinkClick event handler.