php-doc-en/reference/fdf/functions/fdf-add-doc-javascript.xml
2003-08-16 17:06:53 +00:00

76 lines
2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/fdf.xml, last change in rev 1.12 -->
<refentry id='function.fdf-add-doc-javascript'>
<refnamediv>
<refname>fdf_add_doc_javascript</refname>
<refpurpose>Adds javascript code to the FDF document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>fdf_add_doc_javascript</methodname>
<methodparam><type>resource</type><parameter>fdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>script_name</parameter></methodparam>
<methodparam><type>string</type><parameter>script_code</parameter></methodparam>
</methodsynopsis>
<para>
Adds a script to the FDF, which Acrobat then adds to the doc-level
scripts of a document, once the FDF is imported into it. It is strongly
suggested to use '\r' for linebreaks within <parameter>script_code</parameter>.
</para>
<para>
<example>
<title>Adding JavaScript code to a FDF</title>
<programlisting role="php">
<![CDATA[
<?php
$fdf = fdf_create();
fdf_add_doc_javascript($fdf, "PlusOne", "function PlusOne(x)\r{\r return x+1;\r}\r");
fdf_save($fdf);
?>
]]>
</programlisting>
<simpara>will create a FDF like this:</simpara>
<screen>
<![CDATA[
%FDF-1.2
%âãÏÓ
1 0 obj
<<
/FDF << /JavaScript << /Doc [ (PlusOne)(function PlusOne\(x\)\r{\r return x+1;\r}\r)] >> >>
>>
endobj
trailer
<<
/Root 1 0 R
>>
%%EOF
]]>
</screen>
</example>
</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
-->