AddLinkToDestination
Annotations and hotspot links, Page properties
Description
Adds a clickable hotspot rectangle to the selected page which links to another page in the same document. The target page, position and zoom level are specified by a destination object which can be created with the NewDestination function.
Use the SetAnnotBorderColor function to change the color of the hotspot border.
Syntax
Delphi
function TPDFlib.AddLinkToDestination(Left, Top, Width, Height: Double; DestID, Options: Integer): Integer;ActiveX
Function PDFlib::AddLinkToDestination(Left As Double, Top As Double, Width As Double, Height As Double, DestID As Long, Options As Long) As LongDLL
int DLAddLinkToDestination(int InstanceID, double Left, double Top, double Width, double Height, int DestID, int Options);Parameters
| Left | The left edge of the hotspot rectangle |
|---|---|
| Top | The top edge of the hotspot rectangle |
| Width | The width of the hotspot rectangle |
| Height | The height of the hotspot rectangle |
| DestID | The DestID of a destination object Specifies the appearance of the link: 0 = No border 1 = Draw a border |
| Options |
Return values
| 0 | The DestID property was invalid The link annotation was created successfully |
|---|---|
| 1 |