SubDocument.Hyperlinks Property

Provides access to a collection of hyperlinks in the document.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

HyperlinkCollection Hyperlinks { get; }

VB.NET

ReadOnly Property Hyperlinks As HyperlinkCollection

Property Value

Type	Description
HyperlinkCollection	A HyperlinkCollection interface which exposes a collection of hyperlinks.

Remarks

Use the HyperlinkCollection.Create method to add a new hyperlink.

Note

The hyperlink attached to a shape is not added to the HyperlinkCollection. Check the Shape.Hyperlink property to retrieve the hyperlink.

Example

The code snippet below finds a specific range in the document and converts it to a hyperlink with the specified URI and tooltip:

C#

using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;

using (var wordProcessor = new RichEditDocumentServer())
{
  wordProcessor.LoadDocument("Documents//Document.docx");
  Document document = wordProcessor.Document;

  // Find a specific text string
  DocumentRange[] foundRanges =
          document.FindAll("DevExpress WinForms Rich Text Editor",
  SearchOptions.CaseSensitive);

  if (foundRanges.Length > 0)
  {
      // Convert the found range to a hyperlink
      Hyperlink hyperlink =  document.Hyperlinks.Create(foundRanges[0]);

      // Specify the URI and the tooltip
      hyperlink.NavigateUri =
           "https://www.devexpress.com/Products/NET/Controls/WinForms/Rich_Editor/";
      hyperlink.ToolTip = "WinForms Rich Text Editor";
  }
}

VB

Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native

Using wordProcessor = New RichEditDocumentServer()
  wordProcessor.LoadDocument("Documents//Document.docx")
  Dim document As Document = wordProcessor.Document

  ' Find a specific text string
  Dim foundRanges() As DocumentRange =
       document.FindAll("DevExpress WinForms Rich Text Editor", SearchOptions.CaseSensitive)

  If foundRanges.Length > 0 Then
      ' Convert the found range to a hyperlink
      Dim hyperlink As Hyperlink = document.Hyperlinks.Create(foundRanges(0))

      ' Specify the URI and the tooltip
      hyperlink.NavigateUri =
           "https://www.devexpress.com/Products/NET/Controls/WinForms/Rich_Editor/"
      hyperlink.ToolTip = "WinForms Rich Text Editor"
  End If
End Using

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Hyperlinks 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-t213968/CS/DXRichEditControlAPISample/CodeExamples/BookmarksAndHyperlinksActions.cs#L22

DocumentPosition pos1 = document.CreatePosition((document.Range.End).ToInt() + 25);
document.Hyperlinks.Create(document.InsertText(pos1, "get to the top"));
document.Hyperlinks[0].Anchor = "Top";

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

DocumentPosition pos1 = document.CreatePosition((document.Range.End).ToInt()+25);
document.Hyperlinks.Create(document.InsertText(pos1, "get to the top"));
document.Hyperlinks[0].Anchor = "Top";

word-processing-document-api-examples-t418535/CS/CodeExamples/BookmarksAndHyperlinks.cs#L23

DocumentPosition pos1 = document.CreatePosition((wordProcessor.Document.Range.End).ToInt() + 25);
document.Hyperlinks.Create(wordProcessor.Document.InsertText(pos1, "get to the top"));
document.Hyperlinks[0].Anchor = "Top";

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

DocumentPosition pos1 = document.CreatePosition((wordProcessor.Document.Range.End).ToInt() + 25);
document.Hyperlinks.Create(wordProcessor.Document.InsertText(pos1, "get to the top"));
document.Hyperlinks[0].Anchor = "Top";

bookmarks-and-hyperlinks-simple-example-t548777/CS/BookmarksAndHyperlinksSimpleExample/Form1.cs#L61

{
    document.Hyperlinks.Create(foundRanges[0]);
    document.Hyperlinks[1].Anchor = "Top";

VB.NET

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

Dim pos1 As DocumentPosition = document.CreatePosition((document.Range.End).ToInt() + 25)
document.Hyperlinks.Create(document.InsertText(pos1, "get to the top"))
document.Hyperlinks(0).Anchor = "Top"

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

Dim pos1 As DocumentPosition = document.CreatePosition((document.Range.End).ToInt()+25)
document.Hyperlinks.Create(document.InsertText(pos1, "get to the top"))
document.Hyperlinks(0).Anchor = "Top"

word-processing-document-api-examples-t418535/VB/CodeExamples/BookmarksAndHyperlinks.vb#L20

Dim pos1 As DocumentPosition = document.CreatePosition((wordProcessor.Document.Range.End).ToInt() + 25)
document.Hyperlinks.Create(wordProcessor.Document.InsertText(pos1, "get to the top"))
document.Hyperlinks(0).Anchor = "Top"

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

Dim pos1 As DevExpress.XtraRichEdit.API.Native.DocumentPosition = document.CreatePosition((wordProcessor.Document.Range.[End]).ToInt() + 25)
document.Hyperlinks.Create(wordProcessor.Document.InsertText(pos1, "get to the top"))
document.Hyperlinks(CInt((0))).Anchor = "Top"

bookmarks-and-hyperlinks-simple-example-t548777/VB/BookmarksAndHyperlinksSimpleExample/Form1.vb#L57

If foundRanges.Length > 0 Then
    document.Hyperlinks.Create(foundRanges(0))
    document.Hyperlinks(1).Anchor = "Top"