IdxRichEditHyperlinkCollection.CreateHyperlink(IdxRichEditDocumentRange) Method

Creates a new hyperlink associated with the specified document range.

Declaration

delphi

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

Parameters

Name	Type
ARange	IdxRichEditDocumentRange

Returns

Type
IdxRichEditHyperlink

Remarks

Call this function to create a new hyperlink in the current document. The newly created hyperlink uses a document range as the hot area. Two overloaded variants of the CreateHyperlink function offer two different ways to specify the document range:

The first overloaded variant accepts the document range’s starting position (AStart) and length in characters (ALength);
The second overloaded variant accepts the document range exposed as the IdxRichEditDocumentRange interface (ARange).

The second overloaded variant calls the first overloaded variant and passes the document range’s Start and Length property values as the AStart and ALength parameters, respectively.

Note

Alternatively, you can invoke the CreateHyperlink function exposed by the IdxRichEditSubDocument interface in order to accomplish the same goal.