Adds Links in the page. More...

Data Structures

struct  A3DPDFLinkData
 A3DPDFLinkData structure Since 2017, m_pcJavascriptString can only be defined with a HOOPS Publish Advanced version. With HOOPS Publish Standard version, you should use A3DPDFLinkAddAction. 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...
 
A3DStatus A3DPDFPageInsertLink (A3DPDFPage *pPage, A3DPDFLink *pLink, const A3DPDFRectData *pRectData)
 Function to insert a link in a page. More...
 
A3DStatus A3DPDFPageInsertLinkInTable (A3DPDFPage *pPage, A3DPDFTable *pTable, A3DPDFLink *pLink, A3DInt32 iRowIndex, A3DInt32 iColumnIndex)
 Function to insert a link in a table. 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

◆ A3DPDFELinkHighlightMode

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

◆ A3DPDFLinkCreate()

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 in case of success or an error code
Return values
A3D_SUCCESS
Version
5.2

◆ A3DPDFPageInsertLink()

A3DStatus A3DPDFPageInsertLink ( A3DPDFPage pPage,
A3DPDFLink pLink,
const A3DPDFRectData pRectData 
)

Function to insert a link in a page.

Parameters
[in]pPageThe Page object to work with.
[in]pLinkThe Link object to insert on the page.
[in]pRectDataThe rectangle to specify the position on the page.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
5.2

◆ A3DPDFPageInsertLinkInTable()

A3DStatus A3DPDFPageInsertLinkInTable ( A3DPDFPage pPage,
A3DPDFTable pTable,
A3DPDFLink pLink,
A3DInt32  iRowIndex,
A3DInt32  iColumnIndex 
)

Function to insert a link in a table.

Parameters
[in,out]pPageThe Page object to work with.
[in]pTableThe Table object to insert in the table.
See also
Table Module.
Parameters
[in]pLinkThe Link object to insert in the table.
[in]iRowIndexThe index of the row of the table's cell to insert the link (start from 1)
[in]iColumnIndexThe index of the column of the table's cell to insert the link (start from 1)
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
7.2