AddLinkToLocalFileA

Annotations and hotspot links

Description

The trailing A denotes the ANSI (char) DLL entry point; the ActiveX/COM surface exposes only the Unicode form. Behaviour is identical to AddLinkToLocalFile and string arguments are interpreted using the current SetAnsiMode code page

Adds a clickable hotspot rectangle to the selected page which links to a local file.

The file doesn't have to exist when the PDF is created but should exist when the PDF is viewed for the link to work.

Use the SetAnnotBorderColor function to change the colour of the hotspot border.

Syntax

Delphi

Function DLAddLinkToLocalFileA(InstanceID: Integer; Left, Top, Width, Height: Double; FileName: PAnsiChar; Options: Integer): Integer;

DLL

int DLAddLinkToLocalFileA(int InstanceID, double Left, double Top, double Width, double Height, const char * FileName, int Options);

Parameters

LeftThe left edge of the hotspot rectangle
TopThe top edge of the hotspot rectangle The width of the hotspot rectangle
WidthThe height of the hotspot rectangle
Height
FileNameThe relative or absolute path to the local file.
OptionsSpecifies the appearance of the link and whether the target is opened in a new window or the same window: 0 = No border, same window 1 = Draw a border, same window 2 = No border, new window 3 = Draw a border, new window