uTools-Manuals/docs/php/ps_add_note.html
2019-04-08 23:22:26 +08:00

186 lines
5.5 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 class="docs"><div id="layout">
<div id="layout-content"><div id="function.ps-add-note" class="refentry">
<div class="refnamediv">
<h1 class="refname">ps_add_note</h1>
<p class="verinfo">(PECL ps &gt;= 1.1.0)</p><p class="refpurpose"><span class="refname">ps_add_note</span> &mdash; <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">说明</h3>
<div class="methodsynopsis dc-description">
<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>
) : <span class="type">bool</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">此说明在文档被打印或显示时不可见,只在文档用 Acrobat Distiller 或 Ghostview 转换成 PDF 时显示。</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ps-add-note-parameters">
<h3 class="title">参数</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="ps_new.html" 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">contents</code></dt>
<dd>
<p class="para">
The text of the note.
</p>
</dd>
<dt>
<code class="parameter">title</code></dt>
<dd>
<p class="para">
The title of the note as displayed in the header of the note.
</p>
</dd>
<dt>
<code class="parameter">icon</code></dt>
<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>
<code class="parameter">open</code></dt>
<dd>
<p class="para">
If <code class="parameter">open</code> is unequal to zero the note will
be shown unfolded after opening the document with a pdf viewer.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ps-add-note-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
成功时返回 <strong><code>TRUE</code></strong> 或者在失败时返回 <strong><code>FALSE</code></strong>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ps-add-note-seealso">
<h3 class="title">参见</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="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="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="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="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></div></div></body></html>