<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ps.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.ps-add-locallink.php',
    1 => 'ps_add_locallink',
    2 => 'Adds link to a page in the same document',
  ),
  'up' => 
  array (
    0 => 'ref.ps.php',
    1 => 'PS Functions',
  ),
  'prev' => 
  array (
    0 => 'function.ps-add-launchlink.php',
    1 => 'ps_add_launchlink',
  ),
  'next' => 
  array (
    0 => 'function.ps-add-note.php',
    1 => 'ps_add_note',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/ps/functions/ps-add-locallink.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.ps-add-locallink" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ps_add_locallink</h1>
  <p class="verinfo">(PECL ps &gt;= 1.1.0)</p><p class="refpurpose"><span class="refname">ps_add_locallink</span> &mdash; <span class="dc-title">Adds link to a page in the same document</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.ps-add-locallink-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>ps_add_locallink</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$psdoc</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$llx</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$lly</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$urx</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$ury</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$page</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$dest</code></span><br>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   Places a hyperlink at the given position pointing to a page in the same
   document. Clicking on the link will jump to the given page. The first page
   in a document has number 1.
  </p>
  <p class="para">
   The hyperlink&#039;s source position is a rectangle with its lower left corner at
   (<code class="parameter">llx</code>, <code class="parameter">lly</code>) and its upper
   right corner at (<code class="parameter">urx</code>, <code class="parameter">ury</code>).
   The rectangle has by default a thin blue border.
  </p>
  <p class="para">The note will not be visible if the document
is printed or viewed but it will show up if the document is converted to
pdf by either Acrobat Distiller™ or Ghostview.</p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.ps-add-locallink-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">psdoc</code></dt>
     <dd>
      <p class="para">
       Resource identifier of the postscript file
       as returned by <span class="function"><a href="function.ps-new.php" class="function">ps_new()</a></span>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">llx</code></dt>
     <dd>
      <p class="para">
       The x-coordinate of the lower left corner.
      </p>
     </dd>
    
    
     <dt><code class="parameter">lly</code></dt>
     <dd>
      <p class="para">
       The y-coordinate of the lower left corner.
      </p>
     </dd>
    
    
     <dt><code class="parameter">urx</code></dt>
     <dd>
      <p class="para">
       The x-coordinate of the upper right corner.
      </p>
     </dd>
    
    
     <dt><code class="parameter">ury</code></dt>
     <dd>
      <p class="para">
       The y-coordinate of the upper right corner.
      </p>
     </dd>
    
    
     <dt><code class="parameter">page</code></dt>
     <dd>
      <p class="para">
       The number of the page displayed when clicking on the link.
      </p>
     </dd>
    
    
     <dt><code class="parameter">dest</code></dt>
     <dd>
      <p class="para">
       The parameter <code class="parameter">dest</code> determines how the document
       is being viewed. It can be <code class="literal">fitpage</code>,
       <code class="literal">fitwidth</code>, <code class="literal">fitheight</code>, or
       <code class="literal">fitbbox</code>.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.ps-add-locallink-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on failure.
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.ps-add-locallink-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.ps-add-launchlink.php" class="function" rel="rdfs-seeAlso">ps_add_launchlink()</a> - Adds link which launches file</span></li>
    <li><span class="function"><a href="function.ps-add-pdflink.php" class="function" rel="rdfs-seeAlso">ps_add_pdflink()</a> - Adds link to a page in a second pdf document</span></li>
    <li><span class="function"><a href="function.ps-add-weblink.php" class="function" rel="rdfs-seeAlso">ps_add_weblink()</a> - Adds link to a web location</span></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>