php-doc-en/reference/pdf/functions/pdf-add-note.xml
Katja Schnelle Romaus 79c8f1709c update or add pdf functions
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@202397 c90b9560-bf6c-de11-be94-00142212c4b1
2005-12-08 13:45:05 +00:00

55 lines
2.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-add-note">
<refnamediv>
<refname>pdf_add_note</refname>
<refpurpose>Set annotation for current page [deprecated]</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pdf_add_note</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>llx</parameter></methodparam>
<methodparam><type>float</type><parameter>lly</parameter></methodparam>
<methodparam><type>float</type><parameter>urx</parameter></methodparam>
<methodparam><type>float</type><parameter>ury</parameter></methodparam>
<methodparam><type>string</type><parameter>contents</parameter></methodparam>
<methodparam><type>string</type><parameter>title</parameter></methodparam>
<methodparam><type>string</type><parameter>icon</parameter></methodparam>
<methodparam><type>int</type><parameter>open</parameter></methodparam>
</methodsynopsis>
<para>
Sets an annotation for the current page. <parameter>icon</parameter> is one of
<literal>comment</literal>, <literal>insert</literal>, <literal>note</literal>,
<literal>paragraph</literal>, <literal>newparagraph</literal>,
<literal>key</literal>, or <literal>help</literal>. &return.success;
</para>
<para>
This function is deprecated since PDFlib version 6, use
<function>pdf_create_annotation</function> with <parameter>type=Text</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
-->