<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Adds note to current page</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ps-add-locallink.html">ps_add_locallink</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ps-add-pdflink.html">ps_add_pdflink</a></div>
<div class="up"><a href="ref.ps.html">PS Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ps-add-note" class="refentry">
<div class="refnamediv">
<h1 class="refname">ps_add_note</h1>
<p class="verinfo">(PECL ps >= 1.1.0)</p><p class="refpurpose"><span class="refname">ps_add_note</span> — <span class="dc-title">Adds note to current page</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ps-add-note-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ps_add_note</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$psdoc</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$llx</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$lly</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$urx</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$ury</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$contents</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$title</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$icon</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$open</code></span>
)</div>
<p class="para rdfs-comment">
Adds a note at a certain position on the page. Notes are like little
rectangular sheets with text on it, which can be placed anywhere on
a page. They
are shown either folded or unfolded. If folded, the specified icon
is used as a placeholder.
</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-note-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">psdoc</code></em></span>
<dd>
<p class="para">
Resource identifier of the postscript file
as returned by <span class="function"><a href="function.ps-new.html" class="function">ps_new()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">llx</code></em></span>
<dd>
<p class="para">
The x-coordinate of the lower left corner.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">lly</code></em></span>
<dd>
<p class="para">
The y-coordinate of the lower left corner.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">urx</code></em></span>
<dd>
<p class="para">
The x-coordinate of the upper right corner.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">ury</code></em></span>
<dd>
<p class="para">
The y-coordinate of the upper right corner.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">contents</code></em></span>
<dd>
<p class="para">
The text of the note.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">title</code></em></span>
<dd>
<p class="para">
The title of the note as displayed in the header of the note.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">icon</code></em></span>
<dd>
<p class="para">
The icon shown if the note is folded. This parameter can be set
to <em>comment</em>, <em>insert</em>,
<em>note</em>, <em>paragraph</em>,
<em>newparagraph</em>, <em>key</em>, or
<em>help</em>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">open</code></em></span>
<dd>
<p class="para">
If <em><code class="parameter">open</code></em> is unequal to zero the note will
be shown unfolded after opening the document with a pdf viewer.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ps-add-note-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ps-add-note-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ps-add-pdflink.html" class="function" rel="rdfs-seeAlso">ps_add_pdflink()</a> - Adds link to a page in a second pdf document</span></li>
<li class="member"> <span class="function"><a href="function.ps-add-launchlink.html" class="function" rel="rdfs-seeAlso">ps_add_launchlink()</a> - Adds link which launches file</span></li>
<li class="member"> <span class="function"><a href="function.ps-add-locallink.html" class="function" rel="rdfs-seeAlso">ps_add_locallink()</a> - Adds link to a page in the same document</span></li>
<li class="member"> <span class="function"><a href="function.ps-add-weblink.html" class="function" rel="rdfs-seeAlso">ps_add_weblink()</a> - Adds link to a web location</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ps-add-locallink.html">ps_add_locallink</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ps-add-pdflink.html">ps_add_pdflink</a></div>
<div class="up"><a href="ref.ps.html">PS Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
