Back to Devexpress

Hyperlink.ToolTip Property

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-hyperlink-1fe47ebd.md

latest5.2 KB
Original Source

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.v25.2.Core.dll

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
string ToolTip { get; set; }
vb
Property ToolTip As String

Property Value

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

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.

office-file-api-ai-implementation/CS/Controllers/AccessibilityController.cs#L106

csharp
{
    if (string.IsNullOrEmpty(hyperlink.ToolTip) || hyperlink.ToolTip == hyperlink.NavigateUri)
    {

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

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

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

csharp
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#L52

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

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

vb
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

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

vb
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

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

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

See Also

ShowToolTip

Hyperlink Interface

Hyperlink Members

DevExpress.XtraRichEdit.API.Native Namespace