AddRelativeLinkToFileDestA

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 AddRelativeLinkToFileDest and string arguments are interpreted using the current SetAnsiMode code page

Adds a clickable hotspot rectangle to the selected named destination which links to a specific page and position in another PDF document, using relative path.

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

Syntax

Delphi

Function DLAddRelativeLinkToFileDestA(InstanceID: Integer; Left, Top, Width, Height: Double; FileName, NamedDest: PAnsiChar; Position: Double; NewWindow, Options: Integer): Integer;

DLL

int DLAddRelativeLinkToFileDestA(int InstanceID, double Left, double Top, double Width, double Height, const char * FileName, const char * NamedDest, double Position, int NewWindow, int Options);

Parameters

Left

The horizontal co-ordinate of the left edge of the hotspot rectangle

Top

The vertical co-ordinate of the top edge of the hotspot rectangle

Width

The width of the hotspot rectangle

Height

The height of the hotspot rectangle

The full absolute path and file name of the PDF document to link to, it will be converted to relative path.

FileName

The Named Destination string in the destination document to link to

NamedDest

The vertical co-ordinate on the destination page to link to

Position

NewWindow

0 = Close the current document and then open the new document

1 = Open the current document in a new window

Options

Specifies the appearance of the link:

0 = No border

1 = Draw a border