Hyperlink Property of the Paragraph Object

Hyperlink property of the Paragraph Object in the ABBYY FineReader Engine API — Returns the Hyperlink object describing the hyperlink at the specified character position, or 0 if no hyperlink is present.

This property returns a reference to the Hyperlink object which describes the hyperlink in the position. If there are no hyperlinks, this property is set to 0.

Syntax

C++

HRESULT get_Hyperlink(
   int          Position,
   IHyperlink** Result
);

C#

IHyperlink get_Hyperlink( int Position );

Visual Basic .NET

ReadOnly Property Hyperlink(Position As Integer) As IHyperlink

Parameters

Position

[in] This variable contains the index of a character inside the paragraph.

Result

[out, retval] A pointer to IHyperlink* pointer variable that receives the interface pointer of the Hyperlink output object. This object exposes properties of the hyperlink. If there is no hyperlink, this property is set to 0.

Return values

This function has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

See also

Paragraph

Hyperlink

Working with Properties