IdxRichEditSubDocument.CreateHyperlink(IdxRichEditDocumentRange) Method

Creates a hyperlink for the specified document range.

Declaration

delphi

function CreateHyperlink(const ARange: IdxRichEditDocumentRange): IdxRichEditHyperlink; overload;

Parameters

Name	Type
ARange	IdxRichEditDocumentRange

Returns

Type
IdxRichEditHyperlink

Remarks

Call the CreateHyperlink function to create a new hyperlink in the current document without accessing the hyperlink collection by using the Hyperlinks property. The hyperlink returned by this function uses the document range passed as the ARange parameter as the anchor text.

The overloaded variant allows you to specify the anchor document range by its starting position (the AStart parameter) and length in characters (the ALength parameter).

Note

Alternatively, you can invoke the Hyperlinks.CreateHyperlink function to accomplish the same goal.