.. _group__a3d__pdf__link__module:

###########
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.

**Parameters**


   **pDoc**\ : The Document object to work with.

   **pLinkData**\ : The link parameters.

   **ppLink**\ : The Link object created.


**Returns**


   A3D_SUCCESS in case of success or an error code


.. rst-class:: kind-group kind-record

.. rubric:: Structures
   :class: kind-group-title


.. rst-class:: api-xref-list


* :c:struct:`~A3DPDFLinkData`

.. rst-class:: kind-group kind-enumeration

.. rubric:: Enumerations
   :class: kind-group-title


.. rst-class:: api-xref-list


* :c:enum:`~A3DPDFELinkHighlightMode`

.. rst-class:: kind-group kind-function

.. rubric:: Functions
   :class: kind-group-title


.. rst-class:: api-xref-list


* :c:func:`~A3DPDFLinkCreate`
* :c:func:`~A3DPDFPageInsertLink`
* :c:func:`~A3DPDFPageInsertLinkInTable`

.. toctree::
   :maxdepth: 1
   :hidden:

   ../structures/A3DPDFLinkData
   ../enums/A3DPDFELinkHighlightMode
   ../functions/A3DPDFLinkCreate
   ../functions/A3DPDFPageInsertLink
   ../functions/A3DPDFPageInsertLinkInTable


