ReadOnlyHyperlinkCollection Interface

A collection of Hyperlink objects 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#

[ComVisible(true)]
public interface ReadOnlyHyperlinkCollection :
    ISimpleCollection<Hyperlink>,
    IEnumerable<Hyperlink>,
    IEnumerable,
    ICollection

VB.NET

<ComVisible(True)>
Public Interface ReadOnlyHyperlinkCollection
    Inherits ISimpleCollection(Of Hyperlink),
             IEnumerable(Of Hyperlink),
             IEnumerable,
             ICollection

Related API Members

The following members return ReadOnlyHyperlinkCollection objects:

• ReadOnlyHyperlinkCollection.Get(DocumentRange)

Remarks

Contains a ReadOnlyHyperlinkCollection.Get method that obtains all hyperlinks located in the specified document range. You can access individual items of this collection, but you cannot add or delete items. Use index notation to obtain an individual Hyperlink object from this collection.

The code sample below locates and removes all hyperlinks in the first section:

C#

using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
    Document document = wordProcessor.Document;
    ReadOnlyHyperlinkCollection hyperlinks = document.Hyperlinks.Get(document.Sections[0].Range);
    if (hyperlinks != null)
    {
        foreach (Hyperlink hyperlink in hyperlinks)
        {
            document.Hyperlinks.Remove(hyperlink);
        }
    }
}

VB.NET

Using wordProcessor As New RichEditDocumentServer()
    Dim document As Document = wordProcessor.Document
    Dim hyperlinks As ReadOnlyHyperlinkCollection = document.Hyperlinks.Get(document.Sections(0).Range)
    If hyperlinks IsNot Nothing Then
        For Each hyperlink As Hyperlink In hyperlinks
            document.Hyperlinks.Remove(hyperlink)
        Next hyperlink
    End If
End Using