Hyperlink.ToolTip Property

Gets or sets a text for the tooltip displayed when the mouse hovers over a hyperlink.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v24.1.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

string ToolTip { get; set; }

VB.NET

Property ToolTip As String

Property Value

Type	Description
String	A string containing the tooltip text.

Remarks

The following picture illustrates a tooltip displayed when the mouse pointer is positioned over a hyperlink.

The tooltip is displayed if the HyperlinkOptions.ShowToolTip property is set to true.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ToolTip property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/BookmarksAndHyperlinksActions.cs#L33

document.Hyperlinks[0].NavigateUri = "https://www.devexpress.com/Products/NET/Controls/WinForms/Rich_Editor/";
document.Hyperlinks[0].ToolTip = "WinForms Rich Text Editor";
#endregion #InsertHyperlink

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/BookmarksAndHyperlinks.cs#L33

document.Hyperlinks[0].NavigateUri = "https://www.devexpress.com/Products/NET/Controls/WinForms/Rich_Editor/";
document.Hyperlinks[0].ToolTip = "WinForms Rich Text Editor";
#endregion #InsertHyperlink

word-document-api-examples/CS/CodeExamples/BookmarksAndHyperlinks.cs#L56

// Specify the hyperlink tooltip.
document.Hyperlinks[0].ToolTip = "DevExpress";
#endregion #InsertHyperlink

VB.NET

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/BookmarksAndHyperlinksActions.vb#L29

            document.Hyperlinks(0).NavigateUri = "https://www.devexpress.com/Products/NET/Controls/WinForms/Rich_Editor/"
            document.Hyperlinks(0).ToolTip = "WinForms Rich Text Editor"
'            #End Region ' #InsertHyperlink

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/BookmarksAndHyperlinks.vb#L32

            document.Hyperlinks(CInt((0))).NavigateUri = "https://www.devexpress.com/Products/NET/Controls/WinForms/Rich_Editor/"
            document.Hyperlinks(CInt((0))).ToolTip = "WinForms Rich Text Editor"
#End Region  ' #InsertHyperlink

word-document-api-examples/VB/CodeExamples/BookmarksAndHyperlinks.vb#L48

            ' Specify the hyperlink tooltip.
            document.Hyperlinks(0).ToolTip = "DevExpress"
#End Region  ' #InsertHyperlink