SubDocument.Hyperlinks Property

Provides access to a collection of hyperlinks in the document.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v23.2.Core.dll

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

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