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.v18.2.Core.dll

Declaration

C#

Hyperlink Create(
    DocumentRange range
)

VB.NET

Function Create(
    range As DocumentRange
) As Hyperlink

Parameters

Name	Type	Description
range	DocumentRange	A DocumentRange object specifying a range associated with the hyperlink.

Returns

Type	Description
Hyperlink	A Hyperlink interface exposing the created hyperlink.

Remarks

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

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

Tip

Use the Shape.AddHyperlink method to associate a hyperlink with a Shape object.

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#

bookmarks-and-hyperlinks-simple-example-t548777/CS/BookmarksAndHyperlinksSimpleExample/Form1.cs#L60

{
    document.Hyperlinks.Create(foundRanges[0]);
    document.Hyperlinks[1].Anchor = "Top";

bookmarks-and-hyperlinks-simple-example-t549304/CS/BookmarksAndHyperlinksSimpleExample/MainWindow.xaml.cs#L55

{
    document.Hyperlinks.Create(foundRanges[0]);
    document.Hyperlinks[1].Anchor = "Top";

wpf-richedit-document-api-t213968/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-e5219/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#L23

DocumentPosition pos1 = document.CreatePosition((server.Document.Range.End).ToInt() + 25);
document.Hyperlinks.Create(server.Document.InsertText(pos1, "get to the top"));
document.Hyperlinks[0].Anchor = "Top";

VB.NET

bookmarks-and-hyperlinks-simple-example-t548777/VB/BookmarksAndHyperlinksSimpleExample/Form1.vb#L56

If foundRanges.Length > 0 Then
    document.Hyperlinks.Create(foundRanges(0))
    document.Hyperlinks(1).Anchor = "Top"

bookmarks-and-hyperlinks-simple-example-t549304/VB/BookmarksAndHyperlinksSimpleExample/MainWindow.xaml.vb#L51

If foundRanges.Length > 0 Then
    document.Hyperlinks.Create(foundRanges(0))
    document.Hyperlinks(1).Anchor = "Top"

wpf-richedit-document-api-t213968/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-e5219/VB/RichEditAPISample/CodeExamples/BookmarksAndHyperlinks.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"

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

Dim pos1 As DocumentPosition = document.CreatePosition((server.Document.Range.End).ToInt() + 25)
document.Hyperlinks.Create(server.Document.InsertText(pos1, "get to the top"))
document.Hyperlinks(0).Anchor = "Top"