AddRelativeLinkToLocalFile

Annotations and hotspot links

Description

Adds a clickable hotspot rectangle to the selected page which links using relative path 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 color of the hotspot border.

Syntax

Delphi

function TPDFlib.AddRelativeLinkToLocalFile(Left, Top, Width, Height: Double; Const FileName: WideString; Options: Integer): Integer;

ActiveX

Function PDFlib::AddRelativeLinkToLocalFile(Left As Double, Top As Double, Width As Double, Height As Double, FileName As String, Options As Long) As Long

DLL

int DLAddRelativeLinkToLocalFile(int InstanceID, double Left, double Top, double Width, double Height, wchar_t * FileName, int Options);

Parameters

LeftThe horizontal co-ordinate of the left edge of the hotspot rectangle
TopThe vertical co-ordinate of the top edge of the hotspot rectangle
WidthThe width of the hotspot rectangle
HeightThe 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.
FileNameSpecifies the appearance of the link: 0 = No border 1 = Draw a border
Options