SubDocument.CreateHyperlink(DocumentPosition, Int32) Method

Obsolete. 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.v14.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.