Link Module
Types
Fields
Functions
Detailed Description
- group a3d_pdf_link_module
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.
Type Documentation
-
enum 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
Values:
-
enumerator kA3DPDFLinkHighlightNone
No highlighting.
-
enumerator kA3DPDFLinkHighlightInvert
Invert the contents of the link rectangle.
-
enumerator kA3DPDFLinkHighlightOutline
Invert the link border.
-
enumerator 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.
- Version
5.2
- Parameters
pDoc – [inout] The Document object to work with.
pLinkData – [in] The link parameters.
ppLink – [out] The Link object created.
- Return values
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DPDFPageInsertLink(A3DPDFPage *pPage, A3DPDFLink *pLink, const A3DPDFRectData *pRectData)
Function to insert a link in a page.
- Version
5.2
- Parameters
pPage – [in] The Page object to work with.
pLink – [in] The Link object to insert on the page.
pRectData – [in] The rectangle to specify the position on the page.
- Return values
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DPDFPageInsertLinkInTable(A3DPDFPage *pPage, A3DPDFTable *pTable, A3DPDFLink *pLink, A3DInt32 iRowIndex, A3DInt32 iColumnIndex)
Function to insert a link in a table.
See also
- Version
7.2
- Parameters
pPage – [inout] The Page object to work with.
pTable – [in] The Table object to insert in the table.
pLink – [in] The Link object to insert in the table.
iRowIndex – [in] The index of the row of the table’s cell to insert the link (start from 1)
iColumnIndex – [in] The index of the column of the table’s cell to insert the link (start from 1)
- Return values
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code