ReadOnlyHyperlinkCollection.Get(DocumentRange) Method

Gets all hyperlinks located in the specified document range.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

ReadOnlyHyperlinkCollection Get(
    DocumentRange range
)

VB.NET

Function Get(
    range As DocumentRange
) As ReadOnlyHyperlinkCollection

Parameters

Name	Type	Description
range	DocumentRange	A DocumentRange specifying the range in which to search for hyperlinks.

Returns

Type	Description
ReadOnlyHyperlinkCollection	A ReadOnlyHyperlinkCollection object specifying the read-only collection of hyperlinks.

Remarks

The Get method returns a collection of Hyperlink objects contained in the specified range.

Note

If you operate with a selection range, the Get method should be enclosed within a DocumentRange.BeginUpdateDocument - DocumentRange.EndUpdateDocument method pair. Otherwise, an incorrect document model might be selected, resulting in an exception “Error: specified document position or range belongs to other document or subdocument” being thrown.

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