officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-readonlyhyperlinkcollection-dot-get-x28-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-documentrange-x29.md
Gets all hyperlinks located in the specified document range.
Namespace : DevExpress.XtraRichEdit.API.Native
Assembly : DevExpress.RichEdit.v25.2.Core.dll
NuGet Package : DevExpress.RichEdit.Core
ReadOnlyHyperlinkCollection Get(
DocumentRange range
)
Function Get(
range As DocumentRange
) As ReadOnlyHyperlinkCollection
| Name | Type | Description |
|---|---|---|
| range | DocumentRange |
A DocumentRange specifying the range in which to search for hyperlinks.
|
| Type | Description |
|---|---|
| ReadOnlyHyperlinkCollection |
A ReadOnlyHyperlinkCollection object specifying the read-only collection of hyperlinks.
|
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:
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);
}
}
}
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
See Also
ReadOnlyHyperlinkCollection Interface