< Home

< Programming Guide

< Supported File Formats

REFERENCE MANUAL

Data Structures | Enumerations | Functions
Link Module

Adds Links in the page. More...

Data Structures

struct  A3DPDFLinkData
 A3DPDFLinkData structure. More...
 

Enumerations

enum  A3DPDFELinkHighlightMode { kA3DPDFLinkHighlightNone =0, kA3DPDFLinkHighlightInvert, kA3DPDFLinkHighlightOutline, kA3DPDFLinkHighlightPush }
 Highlighting mode (the visual effect that shall be used when the mouse button is pressed or held down inside its active area) More...
 

Functions

A3DStatus A3DPDFLinkCreate (A3DPDFDocument *pDoc, const A3DPDFLinkData *pLinkData, A3DPDFLink **ppLink)
 Function to create a link object. More...
 

Detailed Description

Adds Links in the page.

This module describes the functions and structures that allow you to add links in the page. A link is a 'hot zone' on which is assigned an action. When the user clicks on the zone, the action is executed. The link can be invisible, or drawn as a rectangle with a border. The border width and color can be specified.

Enumeration Type Documentation

Highlighting mode (the visual effect that shall be used when the mouse button is pressed or held down inside its active area)

Version
5.2
Enumerator
kA3DPDFLinkHighlightNone 

No highlighting.

kA3DPDFLinkHighlightInvert 

Invert the contents of the link rectangle.

kA3DPDFLinkHighlightOutline 

Invert the link border.

kA3DPDFLinkHighlightPush 

Display the link as if it were being pushed below the surface of the page.

Function Documentation

A3DStatus A3DPDFLinkCreate ( A3DPDFDocument pDoc,
const A3DPDFLinkData pLinkData,
A3DPDFLink **  ppLink 
)

Function to create a link object.

The link object is primarily created with this function, and it should be positioned on the page with the function A3DPDFPageInsertLink.

Parameters
[in,out]pDocThe Document object to work with.
[in]pLinkDataThe link parameters.
[out]ppLinkThe Link object created.
Returns
A3D_SUCCESS
Version
5.2