SubDocument.CreateHyperlink(DocumentPosition, Int32) Method

OBSOLETE

This method has become obsolete. Use the 'Create' method instead.

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

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

[Obsolete("This method has become obsolete. Use the 'DevExpress.XtraRichEdit.API.Native.HyperlinkCollection.Create(DocumentPosition start, int length)' method instead.")]
Hyperlink CreateHyperlink(
    DocumentPosition start,
    int length
)

VB.NET

<Obsolete("This method has become obsolete. Use the 'DevExpress.XtraRichEdit.API.Native.HyperlinkCollection.Create(DocumentPosition start, int length)' method instead.")>
Function CreateHyperlink(
    start As DocumentPosition,
    length As Integer
) As Hyperlink

Parameters

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

Returns

Type	Description
Hyperlink	A Hyperlink interface exposing the created hyperlink.

Remarks

The CreateHyperlink 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.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CreateHyperlink(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.CreateHyperlink(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.CreateHyperlink(range.Start, range.Length - 1)
hyperlink.Target = info.FullFileName