HyperlinkCollection.Create(DocumentRange) Method

Creates a hyperlink for the specified document range and adds it to the collection.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

Hyperlink Create(
    DocumentRange range
)

VB.NET

Function Create(
    range As DocumentRange
) As Hyperlink

Parameters

Name	Type	Description
range	DocumentRange	A range associated with the hyperlink.

Returns

Type	Description
Hyperlink	The created hyperlink.

Remarks

The Create method creates a hyperlink with the specified Hyperlink.Range and other characteristics set to null. Use the Hyperlink class properties to adjust the newly created hyperlink.

You can use the Create method overload to convert a document range to a hyperlink. Refer to the following article for a code sample:

Read Tutorial: How to: Convert a Static URI to a Hyperlink

To remove a hyperlink, use the HyperlinkCollection.Remove method.

Tip

Use the Shape.AddHyperlink method to associate a hyperlink with a Shape object. Note that this hyperlink is not added to the HyperlinkCollection.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Create(DocumentRange) method.

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/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/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-document-api-examples/CS/CodeExamples/BookmarksAndHyperlinks.cs#L35

DocumentRange hyperlinkRange = wordProcessor.Document.AppendText("get to the top");
document.Hyperlinks.Create(hyperlinkRange);
document.Hyperlinks[0].Anchor = "Top";

word-document-api-insert-dynamic-content/CS/word-processing-dynamic-content/Program.cs#L85

{
    Hyperlink hyperlink = document.Hyperlinks.Create(range);
    hyperlink.NavigateUri = item.Links[0].Uri.ToString();

VB.NET

wpf-richedit-document-api/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/VB/RichEditAPISample/CodeExamples/BookmarksAndHyperlinks.vb#L21

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

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

Dim hyperlinkRange As DocumentRange = wordProcessor.Document.AppendText("get to the top")
document.Hyperlinks.Create(hyperlinkRange)
document.Hyperlinks(0).Anchor = "Top"

word-document-api-insert-dynamic-content/VB/how-to-insert-dynamic-content/Module1.vb#L72

If item.Links.Count > 0 Then
    Dim hyperlink As Hyperlink = document.Hyperlinks.Create(range)
    hyperlink.NavigateUri = item.Links(0).Uri.ToString()