php-doc-en/reference/pdf/functions/pdf-add-locallink.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
  <refentry id="function.pdf-add-locallink">
   <refnamediv>
    <refname>pdf_add_locallink</refname>
    <refpurpose>Add link annotation for current page [deprecated]</refpurpose>
   </refnamediv>
   <refsect1 role="description">
    &reftitle.description;
     <methodsynopsis>
      <type>bool</type><methodname>pdf_add_locallink</methodname>
      <methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
      <methodparam><type>float</type><parameter>lowerleftx</parameter></methodparam>
      <methodparam><type>float</type><parameter>lowerlefty</parameter></methodparam>
      <methodparam><type>float</type><parameter>upperrightx</parameter></methodparam>
      <methodparam><type>float</type><parameter>upperrighty</parameter></methodparam>
      <methodparam><type>int</type><parameter>page</parameter></methodparam>
      <methodparam><type>string</type><parameter>dest</parameter></methodparam>
     </methodsynopsis>
    <para>
     Add a link annotation to a target within the current PDF file.
     &return.success;
    </para>
    <para>
     <parameter>dest</parameter> is the zoom setting on the destination page,
     it can be one of <literal>retain</literal>, <literal>fitpage</literal>,
     <literal>fitwidth</literal>, <literal>fitheight</literal> or 
     <literal>fitbbox</literal>.
    </para>
    <para>
     This function is deprecated since PDFlib version 6, use <function>pdf_create_action</function> with <parameter>type=GoTo</parameter> and <function>pdf_create_annotation</function> with <parameter>type=Link</parameter> instead.
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->