HyperlinkCollection.Create(DocumentPosition, Int32) Method

Creates a hyperlink for the document range, starting at the specified position, and extending through the specified length and adds it to the collection.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

Hyperlink Create(
    DocumentPosition start,
    int length
)

VB.NET

Function Create(
    start As DocumentPosition,
    length As Integer
) As Hyperlink

Parameters

Name	Type	Description
start	DocumentPosition	A DocumentPosition object specifying a starting position of a range associated with the hyperlink.
length	Int32	An integer specifying the length of a hyperlink’s range.

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. Note that this hyperlink is not added to the HyperlinkCollection.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Create(DocumentPosition, Int32) 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#

how-to-create-an-editor-similar-to-outlook-attachment-editor-e4911/CS/WindowsFormsApplication1/WindowsFormsApplication1/AttachmentsEditor.cs#L87

DocumentRange range = server.Document.AppendText(info.FileName + "; ");
Hyperlink hyperlink = server.Document.Hyperlinks.Create(range.Start, range.Length - 1);
hyperlink.Target = info.FullFileName;

VB.NET

how-to-create-an-editor-similar-to-outlook-attachment-editor-e4911/VB/WindowsFormsApplication1/AttachmentsEditor.vb#L91

Dim range As DocumentRange = server.Document.AppendText(info.FileName & "; ")
Dim hyperlink As Hyperlink = server.Document.Hyperlinks.Create(range.Start, range.Length - 1)
hyperlink.Target = info.FullFileName