GetHyperlinkRange Method of the Paragraph Object

GetHyperlinkRange method of the Paragraph Object in the ABBYY FineReader Engine API — Returns the start index and length of the hyperlink string at the specified character position.

This method analyzes a single hyperlink character and detects the index of the initial character and the length of the string that forms the hyperlink. The analyzed character must have a non-null value of the IParagraph::Hyperlink property.

Syntax

C++

HRESULT GetHyperlinkRange(
  int  Position,
  int* StartPos,
  int* Count
);

C#

void GetHyperlinkRange(
  int     Position,
  out int StartPos,
  out int Count
);

Visual Basic .NET

Sub GetHyperlinkRange( _
  Position As Integer, _
  ByRef StartPos As Integer, _
  ByRef Count As Integer _
)

Parameters

Position

[in] The index of the analyzed character. The analyzed character in this position must have a non-null value of the IParagraph::Hyperlink property.

StartPos

[in, out] The index of the initial character of the hyperlink.

Count

[in, out] The length of the string that forms the hyperlink.

Return values

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

See also

Paragraph