<!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 javascript code to the FDF document</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ref.fdf.html">FDF Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.fdf-add-template.html">fdf_add_template</a></div>
<div class="up"><a href="ref.fdf.html">FDF Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.fdf-add-doc-javascript" class="refentry">
<div class="refnamediv">
<h1 class="refname">fdf_add_doc_javascript</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">fdf_add_doc_javascript</span> — <span class="dc-title">Adds javascript code to the FDF document</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.fdf-add-doc-javascript-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>fdf_add_doc_javascript</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$fdf_document</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$script_name</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$script_code</code></span>
)</div>
<p class="para rdfs-comment">
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.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.fdf-add-doc-javascript-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">fdf_document</code></em></span>
<dd>
<p class="para">
The FDF document handle, returned by <span class="function"><a href="function.fdf-create.html" class="function">fdf_create()</a></span>,
<span class="function"><a href="function.fdf-open.html" class="function">fdf_open()</a></span> or <span class="function"><a href="function.fdf-open-string.html" class="function">fdf_open_string()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">script_name</code></em></span>
<dd>
<p class="para">
The script name.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">script_code</code></em></span>
<dd>
<p class="para">
The script code. It is strongly suggested to use <em>\r</em>
for linebreaks within the script code.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.fdf-add-doc-javascript-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 examples" id="refsect1-function.fdf-add-doc-javascript-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3482">
<p><strong>Example #1 Adding JavaScript code to a FDF</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$fdf </span><span style="color: #007700">= </span><span style="color: #0000BB">fdf_create</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">fdf_add_doc_javascript</span><span style="color: #007700">(</span><span style="color: #0000BB">$fdf</span><span style="color: #007700">, </span><span style="color: #DD0000">"PlusOne"</span><span style="color: #007700">, </span><span style="color: #DD0000">"function PlusOne(x)\r{\r return x+1;\r}\r"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fdf_save</span><span style="color: #007700">(</span><span style="color: #0000BB">$fdf</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>
will create a FDF like this:
</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
%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
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ref.fdf.html">FDF Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.fdf-add-template.html">fdf_add_template</a></div>
<div class="up"><a href="ref.fdf.html">FDF Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
