LinkActionAtPagePoint

Viewer interaction, annotations and hotspot links

Description

Finds the link annotation covering the given point on a page and fills Info with its typed action. The scan walks the page annotations in document order and returns the first whose action kind is not

akNone; the hit band is accepted on either side of the annotation top so both vertical origin conventions hit, and the coordinates use the page user space in which the underlying library reports annotation rectangles

Syntax

Delphi

Function TPDFlibViewer.LinkActionAtPagePoint(APage: Integer; XPos, YPos: Double; Out Info: TPDFlibActionInfo): Integer;

Parameters

APageOne-based page index
XPos, YPosPoint in page user-space coordinates
InfoReceives the typed action of the covering link, zeroed when no link was hit

Return values

0No link with an action covers the point, the page is invalid or no library is loaded
Positive valueOne-based annotation index of the covering link

See also

TPDFlibViewer, AnnotAtPagePoint, FormFieldAtPagePoint, RegionAtClientPoint, TPDFlibActionInfo