32
1
mirror of https://github.com/vdm-io/tcpdf.git synced 2024-12-29 11:02:38 +00:00
tcpdf/doc/com-tecnick-tcpdf/TCPDF.html

21266 lines
693 KiB
HTML
Raw Normal View History

2009-03-24 18:37:18 +00:00
<html>
<head>
<title>Docs For Class TCPDF</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
<tr>
<td class="header_top">com-tecnick-tcpdf</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
<tr>
<td class="header_menu">
[ <a href="../classtrees_com-tecnick-tcpdf.html" class="menu">class tree: com-tecnick-tcpdf</a> ]
[ <a href="../elementindex_com-tecnick-tcpdf.html" class="menu">index: com-tecnick-tcpdf</a> ]
[ <a href="../elementindex.html" class="menu">all elements</a> ]
</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
</table>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="200" class="menu">
<b>Packages:</b><br />
<a href="../li_com-tecnick-tcpdf.html">com-tecnick-tcpdf</a><br />
<br /><br />
<b>Files:</b><br />
<div class="package">
<a href="../com-tecnick-tcpdf/_barcodes.php.html"> barcodes.php
</a><br>
<a href="../com-tecnick-tcpdf/_htmlcolors.php.html"> htmlcolors.php
</a><br>
<a href="../com-tecnick-tcpdf/_tcpdf.php.html"> tcpdf.php
</a><br>
<a href="../com-tecnick-tcpdf/_config---tcpdf_config.php.html"> tcpdf_config.php
</a><br>
<a href="../com-tecnick-tcpdf/_unicode_data.php.html"> unicode_data.php
</a><br>
</div><br />
<b>Classes:</b><br />
<div class="package">
<a href="../com-tecnick-tcpdf/TCPDF.html">TCPDF</a><br />
<a href="../com-tecnick-tcpdf/TCPDFBarcode.html">TCPDFBarcode</a><br />
</div>
</td>
<td>
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
<h1>Class: TCPDF</h1>
Source Location: /tcpdf.php<br /><br />
<table width="100%" border="0">
<tr><td valign="top">
<h3><a href="#class_details">Class Overview</a></h3>
<pre></pre><br />
<div class="description">This is a PHP class for generating PDF documents without requiring external extensions.<br /></div><br /><br />
<h4>Author(s):</h4>
<ul>
<li>Nicola Asuni - info@tecnick.com</li>
</ul>
<h4>Version:</h4>
<ul>
2010-03-20 13:26:55 +00:00
<li>4.8.039</li>
2009-03-24 18:37:18 +00:00
</ul>
</td>
<td valign="top">
<h3><a href="#class_vars">Variables</a></h3>
<ul>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$AliasNbPages">$AliasNbPages</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$AliasNumPage">$AliasNumPage</a></li>
2009-09-09 21:21:25 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$annotation_fonts">$annotation_fonts</a></li>
2009-08-29 16:09:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$annots_start_obj_id">$annots_start_obj_id</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$annot_obj_id">$annot_obj_id</a></li>
2009-09-09 21:21:25 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$apxo_obj_id">$apxo_obj_id</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$apxo_start_obj_id">$apxo_start_obj_id</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$author">$author</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$AutoPageBreak">$AutoPageBreak</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$barcode">$barcode</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$bgcolor">$bgcolor</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$bMargin">$bMargin</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$booklet">$booklet</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$buffer">$buffer</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$bufferlen">$bufferlen</a></li>
2009-08-25 18:07:52 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$byterange_string">$byterange_string</a></li>
2010-01-19 08:38:30 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$cache_file_length">$cache_file_length</a></li>
2009-04-09 17:29:09 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$cache_maxsize_UTF8StringToArray">$cache_maxsize_UTF8StringToArray</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$cache_size_UTF8StringToArray">$cache_size_UTF8StringToArray</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$cache_UTF8StringToArray">$cache_UTF8StringToArray</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$cell_height_ratio">$cell_height_ratio</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$cMargin">$cMargin</a></li>
2009-07-20 13:44:38 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$cntmrk">$cntmrk</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$ColorFlag">$ColorFlag</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$compress">$compress</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$CoreFonts">$CoreFonts</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$creator">$creator</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$CurOrientation">$CurOrientation</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$CurrentFont">$CurrentFont</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$currpagegroup">$currpagegroup</a></li>
2009-09-15 11:07:16 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$curr_annot_obj_id">$curr_annot_obj_id</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$customlistindent">$customlistindent</a></li>
2009-09-07 21:53:40 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$default_form_prop">$default_form_prop</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$default_monospaced_font">$default_monospaced_font</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$default_table_columns">$default_table_columns</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$diffs">$diffs</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$diskcache">$diskcache</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$dpi">$dpi</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$DrawColor">$DrawColor</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$embeddedfiles">$embeddedfiles</a></li>
2009-08-29 16:09:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$embedded_start_obj_id">$embedded_start_obj_id</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$encoding">$encoding</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$encrypted">$encrypted</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$encryption_key">$encryption_key</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$enc_obj_id">$enc_obj_id</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$endlinex">$endlinex</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$epsmarker">$epsmarker</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$extgstates">$extgstates</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$feps">$feps</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$fgcolor">$fgcolor</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$fhPt">$fhPt</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$FillColor">$FillColor</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$FontAscent">$FontAscent</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$FontDescent">$FontDescent</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$FontFamily">$FontFamily</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$FontFiles">$FontFiles</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$fontkeys">$fontkeys</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$fontlist">$fontlist</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$fonts">$fonts</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$FontSize">$FontSize</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$FontSizePt">$FontSizePt</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$FontStyle">$FontStyle</a></li>
2009-09-09 21:21:25 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$font_obj_ids">$font_obj_ids</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$footerlen">$footerlen</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$footerpos">$footerpos</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$footer_font">$footer_font</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$footer_margin">$footer_margin</a></li>
2009-09-07 21:53:40 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$form_action">$form_action</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$form_enctype">$form_enctype</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$form_mode">$form_mode</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$form_obj_id">$form_obj_id</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$fwPt">$fwPt</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$gradients">$gradients</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$h">$h</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$header_font">$header_font</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$header_logo">$header_logo</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$header_logo_width">$header_logo_width</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$header_margin">$header_margin</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$header_string">$header_string</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$header_title">$header_title</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$hPt">$hPt</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$HREF">$HREF</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$htmlLinkColorArray">$htmlLinkColorArray</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$htmlLinkFontStyle">$htmlLinkFontStyle</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$htmlvspace">$htmlvspace</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$imagekeys">$imagekeys</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$images">$images</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$imgscale">$imgscale</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$img_rb_x">$img_rb_x</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$img_rb_y">$img_rb_y</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$InFooter">$InFooter</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$internal_encoding">$internal_encoding</a></li>
2010-01-25 17:14:23 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$inthead">$inthead</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$intmrk">$intmrk</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$isunicode">$isunicode</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$javascript">$javascript</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$jpeg_quality">$jpeg_quality</a></li>
2009-09-07 21:53:40 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$js_objects">$js_objects</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$js_obj_id">$js_obj_id</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$js_start_obj_id">$js_start_obj_id</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$k">$k</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$keywords">$keywords</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$l">$l</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$lasth">$lasth</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$last_rc4_key">$last_rc4_key</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$last_rc4_key_c">$last_rc4_key_c</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$LayoutMode">$LayoutMode</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$linestyleCap">$linestyleCap</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$linestyleDash">$linestyleDash</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$linestyleJoin">$linestyleJoin</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$linestyleWidth">$linestyleWidth</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$linethrough">$linethrough</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$LineWidth">$LineWidth</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$links">$links</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$lispacer">$lispacer</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$listcount">$listcount</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$listindent">$listindent</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$listnum">$listnum</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$listordered">$listordered</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$lisymbol">$lisymbol</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$lMargin">$lMargin</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$n">$n</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$newline">$newline</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$newpagegroup">$newpagegroup</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$numfonts">$numfonts</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$numimages">$numimages</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$numpages">$numpages</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$n_js">$n_js</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$n_ocg_print">$n_ocg_print</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$n_ocg_view">$n_ocg_view</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$objcopy">$objcopy</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$offsets">$offsets</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$oldcMargin">$oldcMargin</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$opencell">$opencell</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$openMarkedContent">$openMarkedContent</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$original_lMargin">$original_lMargin</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$original_rMargin">$original_rMargin</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$OutlineRoot">$OutlineRoot</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$outlines">$outlines</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$Ovalue">$Ovalue</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$padding">$padding</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$page">$page</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$PageAnnots">$PageAnnots</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$PageBreakTrigger">$PageBreakTrigger</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$pagedim">$pagedim</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$pagegroups">$pagegroups</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$pagelen">$pagelen</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$PageMode">$PageMode</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$pageopen">$pageopen</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$pages">$pages</a></li>
2009-08-29 16:09:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$page_obj_id">$page_obj_id</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$PDFVersion">$PDFVersion</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$premode">$premode</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$print_footer">$print_footer</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$print_header">$print_header</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$Pvalue">$Pvalue</a></li>
2009-09-09 21:21:25 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$radiobutton_groups">$radiobutton_groups</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$radio_groups">$radio_groups</a></li>
2009-04-28 08:12:11 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$re_spaces">$re_spaces</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$rMargin">$rMargin</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$rtl">$rtl</a></li>
2009-04-25 08:54:01 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$sign">$sign</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$signature_data">$signature_data</a></li>
2010-01-19 08:38:30 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$signature_max_length">$signature_max_length</a></li>
2009-08-25 18:07:52 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$sig_annot_ref">$sig_annot_ref</a></li>
2009-07-23 23:08:13 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$sig_obj_id">$sig_obj_id</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$spot_colors">$spot_colors</a></li>
2009-09-23 17:10:28 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$start_transaction_page">$start_transaction_page</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$state">$state</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$subject">$subject</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$tagvspaces">$tagvspaces</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$tempfontsize">$tempfontsize</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$TextColor">$TextColor</a></li>
2009-09-23 17:10:28 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$textindent">$textindent</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$thead">$thead</a></li>
2009-06-04 12:29:52 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$theadMargins">$theadMargins</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$title">$title</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$tMargin">$tMargin</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$tmprtl">$tmprtl</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$transfmatrix">$transfmatrix</a></li>
2009-09-17 20:37:43 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$transfmatrix_key">$transfmatrix_key</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$transfmrk">$transfmrk</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$underline">$underline</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$ur">$ur</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$ur_annots">$ur_annots</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$ur_document">$ur_document</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$ur_form">$ur_form</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$ur_signature">$ur_signature</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$Uvalue">$Uvalue</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$viewer_preferences">$viewer_preferences</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$visibility">$visibility</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$w">$w</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$wPt">$wPt</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$x">$x</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$y">$y</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#var$ZoomMode">$ZoomMode</a></li>
</ul>
</td>
<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method__construct">__construct</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method__destruct">__destruct</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodAcceptPageBreak">AcceptPageBreak</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodaddExtGState">addExtGState</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodAddFont">AddFont</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodaddHtmlLink">addHtmlLink</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodaddHTMLVertSpace">addHTMLVertSpace</a></li>
2009-09-07 21:53:40 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodaddJavascriptObject">addJavascriptObject</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodAddLink">AddLink</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodAddPage">AddPage</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodAddSpotColor">AddSpotColor</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodaddTOC">addTOC</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodAliasNbPages">AliasNbPages</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodAliasNumPage">AliasNumPage</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodAnnotation">Annotation</a></li>
2009-07-10 15:38:54 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodArrow">Arrow</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodarrUTF8ToUTF16BE">arrUTF8ToUTF16BE</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodBookmark">Bookmark</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodButton">Button</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodCell">Cell</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodCheckBox">CheckBox</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodcheckPageBreak">checkPageBreak</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodCircle">Circle</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodClip">Clip</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodClose">Close</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodcloseHTMLTagHandler">closeHTMLTagHandler</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodComboBox">ComboBox</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodcommitTransaction">commitTransaction</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodconvertHTMLColorToDec">convertHTMLColorToDec</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodCoonsPatchMesh">CoonsPatchMesh</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodCurve">Curve</a></li>
2009-04-23 08:53:25 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methoddeletePage">deletePage</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodEllipse">Ellipse</a></li>
2009-04-16 15:53:29 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodempty_string">empty_string</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodendPage">endPage</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodError">Error</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodFooter">Footer</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodformatPageNumber">formatPageNumber</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodformatTOCPageNumber">formatTOCPageNumber</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodGetAbsX">GetAbsX</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetAliasNbPages">getAliasNbPages</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetAliasNumPage">getAliasNumPage</a></li>
2009-09-07 21:53:40 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetAnnotOptFromJSProp">getAnnotOptFromJSProp</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodGetArrStringWidth">GetArrStringWidth</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetBarcode">getBarcode</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetBorderMode">getBorderMode</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetBreakMargin">getBreakMargin</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetBuffer">getBuffer</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetCellCode">getCellCode</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetCellHeightRatio">getCellHeightRatio</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodGetCharWidth">GetCharWidth</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetFontBuffer">getFontBuffer</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetFontFamily">getFontFamily</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetFontSize">getFontSize</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetFontSizePt">getFontSizePt</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetFontsList">getFontsList</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetFontStyle">getFontStyle</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetFooterFont">getFooterFont</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetFooterMargin">getFooterMargin</a></li>
2009-09-07 21:53:40 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetFormDefaultProp">getFormDefaultProp</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetGDgamma">getGDgamma</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetGraphicVars">getGraphicVars</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetGroupPageNo">getGroupPageNo</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetGroupPageNoFormatted">getGroupPageNoFormatted</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetHeaderData">getHeaderData</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetHeaderFont">getHeaderFont</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetHeaderMargin">getHeaderMargin</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetHtmlDomArray">getHtmlDomArray</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetHTMLUnitToUnits">getHTMLUnitToUnits</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetImageBuffer">getImageBuffer</a></li>
2009-11-27 14:28:24 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetImageFileType">getImageFileType</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetImageRBX">getImageRBX</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetImageRBY">getImageRBY</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetImageScale">getImageScale</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetLastH">getLastH</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodGetLineWidth">GetLineWidth</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetMargins">getMargins</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodGetNumChars">GetNumChars</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetNumLines">getNumLines</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetNumPages">getNumPages</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetObjFilename">getObjFilename</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetOriginalMargins">getOriginalMargins</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetPage">getPage</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetPageBuffer">getPageBuffer</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetPageDimensions">getPageDimensions</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetPageGroupAlias">getPageGroupAlias</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetPageHeight">getPageHeight</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetPageNumGroupAlias">getPageNumGroupAlias</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetPageWidth">getPageWidth</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetPDFData">getPDFData</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetRemainingWidth">getRemainingWidth</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetRTL">getRTL</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetScaleFactor">getScaleFactor</a></li>
2010-01-15 16:00:34 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetSpaceString">getSpaceString</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodGetStringWidth">GetStringWidth</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodGetX">GetX</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodGetY">GetY</a></li>
2009-08-17 16:00:15 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodget_mqr">get_mqr</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodGradient">Gradient</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodHeader">Header</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodImage">Image</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodImageEps">ImageEps</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodImagePngAlpha">ImagePngAlpha</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodIncludeJS">IncludeJS</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodintToRoman">intToRoman</a></li>
2009-11-04 08:57:52 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodisRTLTextDir">isRTLTextDir</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodlastPage">lastPage</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodLine">Line</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodLinearGradient">LinearGradient</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodLink">Link</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodListBox">ListBox</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodLn">Ln</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodMirrorH">MirrorH</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodMirrorL">MirrorL</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodMirrorP">MirrorP</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodMirrorV">MirrorV</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodmovePage">movePage</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodMultiCell">MultiCell</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodobjclone">objclone</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodOpen">Open</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodopenHTMLTagHandler">openHTMLTagHandler</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodOutput">Output</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodPageNo">PageNo</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodPageNoFormatted">PageNoFormatted</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodPieSector">PieSector</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodpixelsToUnits">pixelsToUnits</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodPolycurve">Polycurve</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodPolygon">Polygon</a></li>
2009-09-15 11:07:16 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodPolyLine">PolyLine</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodputHtmlListBullet">putHtmlListBullet</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodRadialGradient">RadialGradient</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodRadioButton">RadioButton</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodreadDiskCache">readDiskCache</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodRect">Rect</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodRegularPolygon">RegularPolygon</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodremoveSHY">removeSHY</a></li>
2010-03-13 19:49:15 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodrevstrpos">revstrpos</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodrfread">rfread</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodrollbackTransaction">rollbackTransaction</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodRotate">Rotate</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodRoundedRect">RoundedRect</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodScale">Scale</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodScaleX">ScaleX</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodScaleXY">ScaleXY</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodScaleY">ScaleY</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetAlpha">setAlpha</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetAuthor">SetAuthor</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetAutoPageBreak">SetAutoPageBreak</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetBarcode">setBarcode</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetBooklet">SetBooklet</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetBuffer">setBuffer</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetCellHeightRatio">setCellHeightRatio</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetCellPadding">SetCellPadding</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetCompression">SetCompression</a></li>
2009-07-20 13:44:38 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetContentMark">setContentMark</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetCreator">SetCreator</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetDefaultMonospacedFont">SetDefaultMonospacedFont</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetDefaultTableColumns">setDefaultTableColumns</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetDisplayMode">SetDisplayMode</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetDrawColor">SetDrawColor</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetDrawColorArray">SetDrawColorArray</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetDrawSpotColor">SetDrawSpotColor</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetExtGState">setExtGState</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFillColor">SetFillColor</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFillColorArray">SetFillColorArray</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFillSpotColor">SetFillSpotColor</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFont">SetFont</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetFontBuffer">setFontBuffer</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFontSize">SetFontSize</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetFontSubBuffer">setFontSubBuffer</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetFooter">setFooter</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetFooterFont">setFooterFont</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetFooterMargin">setFooterMargin</a></li>
2009-09-07 21:53:40 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetFormDefaultProp">setFormDefaultProp</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetGraphicVars">setGraphicVars</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetHeader">setHeader</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetHeaderData">setHeaderData</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetHeaderFont">setHeaderFont</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetHeaderMargin">setHeaderMargin</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetHtmlLinksStyle">setHtmlLinksStyle</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetHtmlVSpace">setHtmlVSpace</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetImageBuffer">setImageBuffer</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetImageScale">setImageScale</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetImageSubBuffer">setImageSubBuffer</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetJPEGQuality">setJPEGQuality</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetKeywords">SetKeywords</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetLanguageArray">setLanguageArray</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetLastH">setLastH</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLeftMargin">SetLeftMargin</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">SetLineStyle</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineWidth">SetLineWidth</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLink">SetLink</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetListIndentWidth">setListIndentWidth</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetLIsymbol">setLIsymbol</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetMargins">SetMargins</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetOpenCell">setOpenCell</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetPage">setPage</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetPageBuffer">setPageBuffer</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetPageFormat">setPageFormat</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetPageMark">setPageMark</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetPageOrientation">setPageOrientation</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetPageUnit">setPageUnit</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetPDFVersion">setPDFVersion</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetPrintFooter">setPrintFooter</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetPrintHeader">setPrintHeader</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetProtection">SetProtection</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetRightMargin">SetRightMargin</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetRTL">setRTL</a></li>
2009-04-25 08:54:01 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetSignature">setSignature</a></li>
2009-06-15 12:18:24 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetSpacesRE">setSpacesRE</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetSubject">SetSubject</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetTableHeader">setTableHeader</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetTempRTL">setTempRTL</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTextColor">SetTextColor</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTextColorArray">SetTextColorArray</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTextSpotColor">SetTextSpotColor</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTitle">SetTitle</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTopMargin">SetTopMargin</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetUserRights">setUserRights</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetViewerPreferences">setViewerPreferences</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetVisibility">setVisibility</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetX">SetX</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetXY">SetXY</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetY">SetY</a></li>
2009-08-17 16:00:15 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodset_mqr">set_mqr</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSkew">Skew</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSkewX">SkewX</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodSkewY">SkewY</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodStarPolygon">StarPolygon</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodstartPage">startPage</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodstartPageGroup">startPageGroup</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodstartTransaction">startTransaction</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">StartTransform</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">StopTransform</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodswapMargins">swapMargins</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodText">Text</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodTextField">TextField</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodTransform">Transform</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodTranslate">Translate</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodTranslateX">TranslateX</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodTranslateY">TranslateY</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodunhtmlentities">unhtmlentities</a></li>
2009-04-09 17:29:09 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodUniArrSubString">UniArrSubString</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodunichr">unichr</a></li>
2009-04-09 17:29:09 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodUTF8ArrayToUniArray">UTF8ArrayToUniArray</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodUTF8ArrSubString">UTF8ArrSubString</a></li>
2010-01-15 11:32:16 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodUTF8ArrToLatin1">UTF8ArrToLatin1</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodutf8Bidi">utf8Bidi</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodUTF8StringToArray">UTF8StringToArray</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodutf8StrRev">utf8StrRev</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodUTF8ToLatin1">UTF8ToLatin1</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodUTF8ToUTF16BE">UTF8ToUTF16BE</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodWrite">Write</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodwrite1DBarcode">write1DBarcode</a></li>
2009-04-09 17:29:09 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodwrite2DBarcode">write2DBarcode</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodwriteBarcode">writeBarcode</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodwriteDiskCache">writeDiskCache</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodwriteHTML">writeHTML</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#methodwriteHTMLCell">writeHTMLCell</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_addfield">_addfield</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_beginpage">_beginpage</a></li>
2010-02-12 16:46:01 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_dataannobjstring">_dataannobjstring</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_datastring">_datastring</a></li>
2009-08-25 18:07:52 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_datestring">_datestring</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_destroy">_destroy</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_dochecks">_dochecks</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_dolinethrough">_dolinethrough</a></li>
2009-09-29 11:19:41 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_dolinethroughw">_dolinethroughw</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_dounderline">_dounderline</a></li>
2009-09-29 11:19:41 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_dounderlinew">_dounderlinew</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_enddoc">_enddoc</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_endpage">_endpage</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_escape">_escape</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_escapetext">_escapetext</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_freadint">_freadint</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_generateencryptionkey">_generateencryptionkey</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_getfontpath">_getfontpath</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_JScolor">_JScolor</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_md5_16">_md5_16</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_newobj">_newobj</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_objectkey">_objectkey</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_out">_out</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_outarc">_outarc</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_outCurve">_outCurve</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_outLine">_outLine</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_outPoint">_outPoint</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_outRect">_outRect</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_Ovalue">_Ovalue</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_parsejpeg">_parsejpeg</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_parsepng">_parsepng</a></li>
2009-08-29 16:09:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putannotsobjs">_putannotsobjs</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putannotsrefs">_putannotsrefs</a></li>
2009-09-09 21:21:25 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putAPXObject">_putAPXObject</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putbookmarks">_putbookmarks</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putcatalog">_putcatalog</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putcidfont0">_putcidfont0</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putEmbeddedFiles">_putEmbeddedFiles</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putencryption">_putencryption</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putextgstates">_putextgstates</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putfonts">_putfonts</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putfontwidths">_putfontwidths</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putheader">_putheader</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putimages">_putimages</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putinfo">_putinfo</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putjavascript">_putjavascript</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putocg">_putocg</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putpages">_putpages</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putresourcedict">_putresourcedict</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putresources">_putresources</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putshaders">_putshaders</a></li>
2009-07-23 23:08:13 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putsignature">_putsignature</a></li>
2009-03-24 18:37:18 +00:00
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putspotcolors">_putspotcolors</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putstream">_putstream</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_puttrailer">_puttrailer</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_puttruetypeunicode">_puttruetypeunicode</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putviewerpreferences">_putviewerpreferences</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_putxobjectdict">_putxobjectdict</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_RC4">_RC4</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_textstring">_textstring</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_toJPEG">_toJPEG</a></li>
<li><a href="../com-tecnick-tcpdf/TCPDF.html#method_Uvalue">_Uvalue</a></li>
</ul>
</td>
</tr></table>
<hr />
<table width="100%" border="0"><tr>
</tr></table>
<hr />
<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
2009-08-29 12:54:16 +00:00
[line 167]<br />
2009-03-24 18:37:18 +00:00
This is a PHP class for generating PDF documents without requiring external extensions.<br /><br /><br /><p>TCPDF project (http://www.tcpdf.org) has been originally derived in 2002 from the Public Domain FPDF class by Olivier Plathey (http://www.fpdf.org), but now is almost entirely rewritten.<br /></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni - info@tecnick.com</td>
</tr>
<tr>
2010-03-20 13:26:55 +00:00
<td><b>version:</b>&nbsp;&nbsp;</td><td>4.8.039</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
<td><b>link:</b>&nbsp;&nbsp;</td><td><a href="http://www.tcpdf.org">http://www.tcpdf.org</a></td>
</tr>
<tr>
<td><b>name:</b>&nbsp;&nbsp;</td><td>TCPDF</td>
</tr>
<tr>
<td><b>license:</b>&nbsp;&nbsp;</td><td><a href="http://www.gnu.org/copyleft/lesser.html">LGPL</a></td>
</tr>
</table>
</div>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<hr />
<a name="class_vars"></a>
<h3>Class Variables</h3>
<div class="tags">
<a name="var$AliasNbPages"></a>
<p></p>
<h4>$AliasNbPages = <span class="value">&nbsp;'{nb}'</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 508]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>for total number of pages</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>alias</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$AliasNumPage"></a>
<p></p>
<h4>$AliasNumPage = <span class="value">&nbsp;'{pnb}'</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 514]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>for page number</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>alias</td>
2009-09-09 21:21:25 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$annotation_fonts"></a>
<p></p>
<h4>$annotation_fonts = <span class="value">array()</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1452]</p>
2009-09-09 21:21:25 +00:00
List of fonts used on form fields (fontname =&gt; fontkey).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.001 (2009-09-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
2009-08-29 16:09:18 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$annots_start_obj_id"></a>
<p></p>
<h4>$annots_start_obj_id = <span class="value">&nbsp;200000</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1361]</p>
2009-08-29 16:09:18 +00:00
Start ID for annotation objects<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.7.000 (2009-08-29)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$annot_obj_id"></a>
<p></p>
<h4>$annot_obj_id = <span class="value">&nbsp;200000</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1368]</p>
2009-09-15 11:07:16 +00:00
Max ID of annotation object<br /><br /><br /><br />
2009-08-29 16:09:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.7.000 (2009-08-29)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-09-09 21:21:25 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$apxo_obj_id"></a>
<p></p>
<h4>$apxo_obj_id = <span class="value">&nbsp;400000</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1445]</p>
2009-09-09 21:21:25 +00:00
Current ID of appearance streams XObjects<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.001 (2009-09-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$apxo_start_obj_id"></a>
<p></p>
<h4>$apxo_start_obj_id = <span class="value">&nbsp;400000</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1438]</p>
2009-09-09 21:21:25 +00:00
Start ID for appearance streams XObjects<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.001 (2009-09-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-08-29 16:09:18 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$author"></a>
<p></p>
2009-04-16 15:53:29 +00:00
<h4>$author = <span class="value">&nbsp;''</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 490]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>author</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$AutoPageBreak"></a>
<p></p>
<h4>$AutoPageBreak = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 448]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>page breaking</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>automatic</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$barcode"></a>
<p></p>
<h4>$barcode = <span class="value">&nbsp;false</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 606]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>to print on page footer (only if set).</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>Barcode</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$bgcolor"></a>
<p></p>
<h4>$bgcolor = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 699]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>background color</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$bMargin"></a>
<p></p>
<h4>$bMargin = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 289]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>break margin</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>page</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$booklet"></a>
<p></p>
<h4>$booklet = <span class="value">&nbsp;false</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1100]</p>
2009-03-24 18:37:18 +00:00
Booklet mode for double-sided pages<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.2.000 (2008-10-29)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$buffer"></a>
<p></p>
<h4>$buffer = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 193]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>holding in-memory PDF</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>buffer</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$bufferlen"></a>
<p></p>
<h4>$bufferlen = <span class="value">&nbsp;0</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1200]</p>
2010-01-19 08:38:30 +00:00
Length of the buffer in bytes.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2008-12-31)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-08-25 18:07:52 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$byterange_string"></a>
<p></p>
<h4>$byterange_string = <span class="value">&nbsp;'/ByteRange[0&nbsp;**********&nbsp;**********&nbsp;**********]'</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1333]</p>
2009-08-25 18:07:52 +00:00
ByteRange placemark used during signature process.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.6.028 (2009-08-25)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-03-24 18:37:18 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
2010-01-19 08:38:30 +00:00
<a name="var$cache_file_length"></a>
2009-03-24 18:37:18 +00:00
<p></p>
2010-01-19 08:38:30 +00:00
<h4>$cache_file_length = <span class="value">array()</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1256]</p>
2010-01-19 08:38:30 +00:00
Array used to store the lengths of cache files<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.029 (2009-03-19)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-04-09 17:29:09 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$cache_maxsize_UTF8StringToArray"></a>
<p></p>
<h4>$cache_maxsize_UTF8StringToArray = <span class="value">&nbsp;8</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1284]</p>
2009-04-09 17:29:09 +00:00
Maximum size of cache array used for UTF8StringToArray() method.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.037 (2009-04-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$cache_size_UTF8StringToArray"></a>
<p></p>
<h4>$cache_size_UTF8StringToArray = <span class="value">&nbsp;0</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1291]</p>
2009-04-09 17:29:09 +00:00
Current size of cache array used for UTF8StringToArray() method.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.037 (2009-04-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$cache_UTF8StringToArray"></a>
<p></p>
<h4>$cache_UTF8StringToArray = <span class="value">array()</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1277]</p>
2009-04-09 17:29:09 +00:00
Cache array for UTF8StringToArray() method.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.037 (2009-04-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-03-24 18:37:18 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$cell_height_ratio"></a>
<p></p>
<h4>$cell_height_ratio = <span class="value">&nbsp;K_CELL_HEIGHT_RATIO</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 950]</p>
2009-03-24 18:37:18 +00:00
Default cell height ratio.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.014 (2008-05-23)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$cMargin"></a>
<p></p>
<h4>$cMargin = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 296]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>internal padding</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>cell</td>
2009-07-20 13:44:38 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$cntmrk"></a>
<p></p>
<h4>$cntmrk = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 987]</p>
2009-07-20 13:44:38 +00:00
Array used to store content positions inside the pages buffer.<br /><br /><p>keys are the page numbers</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.6.021 (2009-07-20)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$ColorFlag"></a>
<p></p>
<h4>$ColorFlag = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 442]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>whether fill and text colors are different</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>indicates</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$compress"></a>
<p></p>
<h4>$compress = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 211]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>flag</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>compression</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$CoreFonts"></a>
<p></p>
<h4>$CoreFonts = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 332]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>of standard font names</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>array</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$creator"></a>
<p></p>
2009-04-16 15:53:29 +00:00
<h4>$creator = <span class="value">&nbsp;''</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 502]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>creator</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$CurOrientation"></a>
<p></p>
<h4>$CurOrientation = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 217]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>page orientation (P = Portrait, L = Landscape)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$CurrentFont"></a>
<p></p>
<h4>$CurrentFont = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 406]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>font info</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$currpagegroup"></a>
<p></p>
<h4>$currpagegroup = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 908]</p>
2009-03-24 18:37:18 +00:00
Contains the alias of the current page group<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-09-15 11:07:16 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$curr_annot_obj_id"></a>
<p></p>
<h4>$curr_annot_obj_id = <span class="value">&nbsp;200000</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1375]</p>
2009-09-15 11:07:16 +00:00
Current ID of annotation object<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.003 (2009-09-15)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-03-24 18:37:18 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$customlistindent"></a>
<p></p>
<h4>$customlistindent = <span class="value">&nbsp;-1</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1122]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>PARSER: custom indent amount for lists. Negative value means disabled.</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.2.007 (2008-11-12)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>HTML</td>
2009-09-07 21:53:40 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$default_form_prop"></a>
<p></p>
<h4>$default_form_prop = <span class="value">array('lineWidth'=&gt;1,&nbsp;'borderStyle'=&gt;'solid',&nbsp;'fillColor'=&gt;array(255,&nbsp;255,&nbsp;255),'strokeColor'=&gt;array(128,128,128))</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1389]</p>
2010-01-14 14:02:19 +00:00
Deafult Javascript field properties. Possible values are described on official Javascript for Acrobat API reference. Annotation options can be directly specified using the 'aopt' entry.<br /><br /><br /><br />
2009-09-07 21:53:40 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.000 (2009-09-07)</td>
</tr>
2009-09-07 21:53:40 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$default_monospaced_font"></a>
<p></p>
<h4>$default_monospaced_font = <span class="value">&nbsp;'courier'</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1242]</p>
2009-03-24 18:37:18 +00:00
Default monospaced font<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.025 (2009-03-10)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$default_table_columns"></a>
<p></p>
<h4>$default_table_columns = <span class="value">&nbsp;4</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 648]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>number of columns for html table.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>Default</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$diffs"></a>
<p></p>
<h4>$diffs = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 350]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>of encoding differences</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>array</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$diskcache"></a>
<p></p>
<h4>$diskcache = <span class="value">&nbsp;false</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1207]</p>
2009-03-24 18:37:18 +00:00
If true enables disk caching.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2008-12-31)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$dpi"></a>
<p></p>
<h4>$dpi = <span class="value">&nbsp;72</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 887]</p>
2009-03-24 18:37:18 +00:00
Dot Per Inch Document Resolution (do not change)<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$DrawColor"></a>
<p></p>
<h4>$DrawColor = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 424]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>for drawing color</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>commands</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$embeddedfiles"></a>
<p></p>
<h4>$embeddedfiles = <span class="value">array()</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1136]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>of files to embedd</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.4.000 (2008-12-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>array</td>
2009-08-29 16:09:18 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$embedded_start_obj_id"></a>
<p></p>
<h4>$embedded_start_obj_id = <span class="value">&nbsp;100000</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1354]</p>
2009-08-29 16:09:18 +00:00
Start ID for embedded file objects<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.7.000 (2009-08-29)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$encoding"></a>
<p></p>
<h4>$encoding = <span class="value">&nbsp;'UTF-8'</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 718]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>encoding</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.53.0.TC010</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>default</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$encrypted"></a>
<p></p>
<h4>$encrypted = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 748]</p>
2009-03-24 18:37:18 +00:00
Indicates whether document is protected<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000 (2008-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$encryption_key"></a>
<p></p>
<h4>$encryption_key = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 802]</p>
2009-03-24 18:37:18 +00:00
RC4 encryption key<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$enc_obj_id"></a>
<p></p>
<h4>$enc_obj_id = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 776]</p>
2009-03-24 18:37:18 +00:00
encryption object id<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000 (2008-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$endlinex"></a>
<p></p>
<h4>$endlinex = <span class="value">&nbsp;0</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 1016]</p>
2009-03-24 18:37:18 +00:00
End position of the latest inserted line<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.2.000 (2008-07-01)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$epsmarker"></a>
<p></p>
<h4>$epsmarker = <span class="value">&nbsp;'x#!#EPS#!#x'</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 1079]</p>
2009-03-24 18:37:18 +00:00
String used to mark the beginning and end of EPS image blocks<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.1.000 (2008-10-18)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$extgstates"></a>
<p></p>
<h4>$extgstates = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 936]</p>
2009-03-24 18:37:18 +00:00
Array of transparency objects and parameters.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$feps"></a>
<p></p>
2009-07-20 13:44:38 +00:00
<h4>$feps = <span class="value">&nbsp;0.005</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1107]</p>
2009-03-24 18:37:18 +00:00
Epsilon value used for float calculations<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.2.000 (2008-10-29)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$fgcolor"></a>
<p></p>
<h4>$fgcolor = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 669]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>foreground color</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$fhPt"></a>
<p></p>
<h4>$fhPt = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 241]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>of page format in points</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>height</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$FillColor"></a>
<p></p>
<h4>$FillColor = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 430]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>for filling color</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>commands</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$FontAscent"></a>
<p></p>
<h4>$FontAscent = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 387]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>font ascent (distance between font top and baseline)</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.8.000 (2007-03-29)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$FontDescent"></a>
<p></p>
<h4>$FontDescent = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 394]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>font descent (distance between font bottom and baseline)</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.8.000 (2007-03-29)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$FontFamily"></a>
<p></p>
<h4>$FontFamily = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 374]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>font family</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$FontFiles"></a>
<p></p>
<h4>$FontFiles = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 344]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>of font files</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>array</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$fontkeys"></a>
<p></p>
<h4>$fontkeys = <span class="value">array()</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1221]</p>
2009-03-24 18:37:18 +00:00
Store the font keys.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2009-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$fontlist"></a>
<p></p>
<h4>$fontlist = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 663]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>a list of available fonts on filesystem.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>store</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$fonts"></a>
<p></p>
<h4>$fonts = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 338]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>of used fonts</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>array</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$FontSize"></a>
<p></p>
<h4>$FontSize = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 418]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>font size in user unit</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$FontSizePt"></a>
<p></p>
<h4>$FontSizePt = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 412]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>font size in points</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$FontStyle"></a>
<p></p>
<h4>$FontStyle = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 380]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>font style</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
2009-09-09 21:21:25 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$font_obj_ids"></a>
<p></p>
<h4>$font_obj_ids = <span class="value">array()</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1228]</p>
2009-09-09 21:21:25 +00:00
Store the font object IDs.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.001 (2009-09-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$footerlen"></a>
<p></p>
<h4>$footerlen = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 1002]</p>
2010-01-19 08:38:30 +00:00
Array used to store footer length of each page.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.014 (2008-07-29)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$footerpos"></a>
<p></p>
<h4>$footerpos = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 994]</p>
2009-03-24 18:37:18 +00:00
Array used to store footer positions of each page.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.2.000 (2008-07-01)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$footer_font"></a>
<p></p>
<h4>$footer_font = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 594]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>font.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>Footer</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$footer_margin"></a>
<p></p>
<h4>$footer_margin = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 568]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>distance between footer and bottom page margin.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>Minimum</td>
2009-09-07 21:53:40 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$form_action"></a>
<p></p>
<h4>$form_action = <span class="value">&nbsp;''</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1417]</p>
2009-09-07 21:53:40 +00:00
Current form action (used during XHTML rendering)<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.000 (2009-09-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$form_enctype"></a>
<p></p>
<h4>$form_enctype = <span class="value">&nbsp;'application/x-www-form-urlencoded'</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1424]</p>
2009-09-07 21:53:40 +00:00
Current form encryption type (used during XHTML rendering)<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.000 (2009-09-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$form_mode"></a>
<p></p>
<h4>$form_mode = <span class="value">&nbsp;'post'</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1431]</p>
2009-09-07 21:53:40 +00:00
Current method to submit forms.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.000 (2009-09-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$form_obj_id"></a>
<p></p>
<h4>$form_obj_id = <span class="value">array()</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1382]</p>
2009-09-09 21:21:25 +00:00
List of form annotations IDs<br /><br /><br /><br />
2009-09-07 21:53:40 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.000 (2009-09-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$fwPt"></a>
<p></p>
<h4>$fwPt = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 235]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>of page format in points</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>width</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$gradients"></a>
<p></p>
<h4>$gradients = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 971]</p>
2009-03-24 18:37:18 +00:00
Array for storing gradient information.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-06-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$h"></a>
<p></p>
<h4>$h = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 265]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>height of page in user unit</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$header_font"></a>
<p></p>
<h4>$header_font = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 588]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>font.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>Header</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$header_logo"></a>
<p></p>
<h4>$header_logo = <span class="value">&nbsp;''</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 624]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>image logo.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>Header</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$header_logo_width"></a>
<p></p>
<h4>$header_logo_width = <span class="value">&nbsp;30</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 630]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>image logo width in mm.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>Header</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$header_margin"></a>
<p></p>
<h4>$header_margin = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 562]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>distance between header and top page margin.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>Minimum</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$header_string"></a>
<p></p>
<h4>$header_string = <span class="value">&nbsp;''</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 642]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>to print on document header.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>String</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$header_title"></a>
<p></p>
<h4>$header_title = <span class="value">&nbsp;''</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 636]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>to print as title on document header.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>String</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$hPt"></a>
<p></p>
<h4>$hPt = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 253]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>height of page in points</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$HREF"></a>
<p></p>
<h4>$HREF = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 657]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>PARSER: array to store current link and rendering styles.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>HTML</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$htmlLinkColorArray"></a>
<p></p>
<h4>$htmlLinkColorArray = <span class="value">array(0,&nbsp;0,&nbsp;255)</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1158]</p>
2009-03-24 18:37:18 +00:00
Default color for html links<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.4.003 (2008-12-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$htmlLinkFontStyle"></a>
<p></p>
<h4>$htmlLinkFontStyle = <span class="value">&nbsp;'U'</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1165]</p>
2009-03-24 18:37:18 +00:00
Default font style to add to html links<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.4.003 (2008-12-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$htmlvspace"></a>
<p></p>
<h4>$htmlvspace = <span class="value">&nbsp;0</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 1058]</p>
2009-03-24 18:37:18 +00:00
Count the latest inserted vertical spaces on HTML<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.021 (2008-08-24)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$imagekeys"></a>
<p></p>
<h4>$imagekeys = <span class="value">array()</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1193]</p>
2009-03-24 18:37:18 +00:00
Store the image keys.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2008-12-31)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$images"></a>
<p></p>
<h4>$images = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 356]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>of used images</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>array</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$imgscale"></a>
<p></p>
<h4>$imgscale = <span class="value">&nbsp;1</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 538]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2009-04-20 16:18:44 +00:00
<td><b>var:</b>&nbsp;&nbsp;</td><td>factor to convert pixels to user units.</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2004-06-14</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
2009-04-20 16:18:44 +00:00
<td>adjusting</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$img_rb_x"></a>
<p></p>
<h4>$img_rb_x = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 522]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>corner X coordinate of inserted image</td>
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2002-07-31</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>right-bottom</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$img_rb_y"></a>
<p></p>
<h4>$img_rb_y = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 530]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>corner Y coordinate of inserted image</td>
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2002-07-31</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>right-bottom</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$InFooter"></a>
<p></p>
<h4>$InFooter = <span class="value">&nbsp;false</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 460]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>set when processing footer</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>flag</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$internal_encoding"></a>
<p></p>
<h4>$internal_encoding = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 725]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>internal encoding</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.53.0.TC016</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>PHP</td>
2010-01-25 17:14:23 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$inthead"></a>
<p></p>
<h4>$inthead = <span class="value">&nbsp;false</span></h4>
<p>[line 1487]</p>
2010-03-10 13:59:05 +00:00
True when we are printing the thead section on a new page<br /><br /><br /><br />
2010-01-25 17:14:23 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.027 (2010-01-25)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$intmrk"></a>
<p></p>
<h4>$intmrk = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 979]</p>
2009-03-24 18:37:18 +00:00
Array used to store positions inside the pages buffer.<br /><br /><p>keys are the page numbers</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.2.000 (2008-06-26)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$isunicode"></a>
<p></p>
<h4>$isunicode = <span class="value">&nbsp;false</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 546]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>set to true when the input text is unicode (require unicode fonts)</td>
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2005-01-02</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>boolean</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$javascript"></a>
<p></p>
<h4>$javascript = <span class="value">&nbsp;''</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 828]</p>
2009-03-24 18:37:18 +00:00
javascript code<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.002 (2008-02-12)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$jpeg_quality"></a>
<p></p>
<h4>$jpeg_quality = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 943]</p>
2009-03-24 18:37:18 +00:00
Set the default JPEG compression quality (1-100)<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-09-07 21:53:40 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$js_objects"></a>
<p></p>
<h4>$js_objects = <span class="value">array()</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1396]</p>
2009-09-07 21:53:40 +00:00
Javascript objects array<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.000 (2009-09-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$js_obj_id"></a>
<p></p>
<h4>$js_obj_id = <span class="value">&nbsp;300000</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1410]</p>
2009-09-07 21:53:40 +00:00
Current ID of javascript object<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.000 (2009-09-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$js_start_obj_id"></a>
<p></p>
<h4>$js_start_obj_id = <span class="value">&nbsp;300000</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1403]</p>
2009-09-07 21:53:40 +00:00
Start ID for javascript objects<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.000 (2009-09-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-03-24 18:37:18 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$k"></a>
<p></p>
<h4>$k = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 229]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>factor (number of points in user unit)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>scale</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$keywords"></a>
<p></p>
2009-04-16 15:53:29 +00:00
<h4>$keywords = <span class="value">&nbsp;''</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 496]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>keywords</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$l"></a>
<p></p>
<h4>$l = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 600]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>templates.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>Language</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$lasth"></a>
<p></p>
<h4>$lasth = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 320]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>of last cell printed</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>height</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$last_rc4_key"></a>
<p></p>
<h4>$last_rc4_key = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 783]</p>
2009-03-24 18:37:18 +00:00
last RC4 key encrypted (cached for optimisation)<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000 (2008-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$last_rc4_key_c"></a>
<p></p>
<h4>$last_rc4_key_c = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 790]</p>
2009-03-24 18:37:18 +00:00
last RC4 computed key<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000 (2008-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$LayoutMode"></a>
<p></p>
<h4>$LayoutMode = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 472]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>display mode</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>layout</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$linestyleCap"></a>
<p></p>
<h4>$linestyleCap = <span class="value">&nbsp;'0&nbsp;J'</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 1030]</p>
2009-03-24 18:37:18 +00:00
PDF string for last line width<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.006 (2008-07-16)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$linestyleDash"></a>
<p></p>
<h4>$linestyleDash = <span class="value">&nbsp;'[]&nbsp;0&nbsp;d'</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 1044]</p>
2009-03-24 18:37:18 +00:00
PDF string for last line width<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.006 (2008-07-16)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$linestyleJoin"></a>
<p></p>
<h4>$linestyleJoin = <span class="value">&nbsp;'0&nbsp;j'</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 1037]</p>
2009-03-24 18:37:18 +00:00
PDF string for last line width<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.006 (2008-07-16)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$linestyleWidth"></a>
<p></p>
<h4>$linestyleWidth = <span class="value">&nbsp;''</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 1023]</p>
2009-03-24 18:37:18 +00:00
PDF string for last line width<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.006 (2008-07-16)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$linethrough"></a>
<p></p>
<h4>$linethrough = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 842]</p>
2009-03-24 18:37:18 +00:00
line trough state<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.8.000 (2008-03-19)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$LineWidth"></a>
<p></p>
<h4>$LineWidth = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 326]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>width in user unit</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>line</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$links"></a>
<p></p>
<h4>$links = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 368]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>of internal links</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>array</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$lispacer"></a>
<p></p>
<h4>$lispacer = <span class="value">&nbsp;''</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 711]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>for LI tags.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>spacer</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$listcount"></a>
<p></p>
<h4>$listcount = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 681]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>PARSER: array count list items on nested lists.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>HTML</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$listindent"></a>
<p></p>
<h4>$listindent = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 693]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>PARSER: indent amount for lists.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>HTML</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$listnum"></a>
<p></p>
<h4>$listnum = <span class="value">&nbsp;0</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 687]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>PARSER: current list nesting level.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>HTML</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$listordered"></a>
<p></p>
<h4>$listordered = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 675]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>PARSER: array of boolean values, true in case of ordered list (OL), false otherwise.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>HTML</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$lisymbol"></a>
<p></p>
<h4>$lisymbol = <span class="value">&nbsp;''</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 1072]</p>
2009-03-24 18:37:18 +00:00
Symbol used for HTML unordered list items<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.028 (2008-09-26)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$lMargin"></a>
<p></p>
<h4>$lMargin = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 271]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>margin</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>left</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$n"></a>
<p></p>
<h4>$n = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 181]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>object number</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$newline"></a>
<p></p>
<h4>$newline = <span class="value">&nbsp;true</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 1009]</p>
2009-03-24 18:37:18 +00:00
True if a newline is created.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.2.000 (2008-07-01)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$newpagegroup"></a>
<p></p>
<h4>$newpagegroup = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 894]</p>
2009-03-24 18:37:18 +00:00
Array of page numbers were a new page group was started<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$numfonts"></a>
<p></p>
<h4>$numfonts = <span class="value">&nbsp;0</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1214]</p>
2009-03-24 18:37:18 +00:00
Counts the number of fonts.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2009-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$numimages"></a>
<p></p>
<h4>$numimages = <span class="value">&nbsp;0</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1186]</p>
2009-03-24 18:37:18 +00:00
Counts the number of pages.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2008-12-31)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$numpages"></a>
<p></p>
<h4>$numpages = <span class="value">&nbsp;0</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1172]</p>
2009-03-24 18:37:18 +00:00
Counts the number of pages.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2008-12-31)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$n_js"></a>
<p></p>
<h4>$n_js = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 835]</p>
2009-03-24 18:37:18 +00:00
javascript counter<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.002 (2008-02-12)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$n_ocg_print"></a>
<p></p>
<h4>$n_ocg_print = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 922]</p>
2009-03-24 18:37:18 +00:00
Print visibility.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$n_ocg_view"></a>
<p></p>
<h4>$n_ocg_view = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 929]</p>
2009-03-24 18:37:18 +00:00
View visibility.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$objcopy"></a>
<p></p>
<h4>$objcopy = <span class="value"></span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1249]</p>
2009-03-24 18:37:18 +00:00
Used to store a cloned copy of the current class object<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.029 (2009-03-19)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$offsets"></a>
<p></p>
<h4>$offsets = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 187]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>of object offsets</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>array</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$oldcMargin"></a>
<p></p>
<h4>$oldcMargin = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 302]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>internal padding (previous value)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>cell</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$opencell"></a>
<p></p>
<h4>$opencell = <span class="value">&nbsp;true</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1129]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>true keeps the border open for the cell sides that cross the page.</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.2.010 (2008-11-14)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>if</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$openMarkedContent"></a>
<p></p>
<h4>$openMarkedContent = <span class="value">&nbsp;false</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 1051]</p>
2009-03-24 18:37:18 +00:00
True if marked-content sequence is open<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.013 (2008-07-28)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$original_lMargin"></a>
<p></p>
<h4>$original_lMargin = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 575]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>left margin value</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.53.0.TC013</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>original</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$original_rMargin"></a>
<p></p>
<h4>$original_rMargin = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 582]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>right margin value</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.53.0.TC013</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>original</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$OutlineRoot"></a>
<p></p>
<h4>$OutlineRoot = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 818]</p>
2009-03-24 18:37:18 +00:00
Outline root for bookmark<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.002 (2008-02-12)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$outlines"></a>
<p></p>
<h4>$outlines = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 811]</p>
2009-03-24 18:37:18 +00:00
Outlines for bookmark<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.002 (2008-02-12)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$Ovalue"></a>
<p></p>
<h4>$Ovalue = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 762]</p>
2009-03-24 18:37:18 +00:00
O entry in pdf document<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000 (2008-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$padding"></a>
<p></p>
<h4>$padding = <span class="value">&nbsp;&quot;\x28\xBF\x4E\x5E\x4E\x75\x8A\x41\x64\x00\x4E\x56\xFF\xFA\x01\x08\x2E\x2E\x00\xB6\xD0\x68\x3E\x80\x2F\x0C\xA9\xFE\x64\x53\x69\x7A&quot;</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 796]</p>
2009-03-24 18:37:18 +00:00
RC4 padding<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$page"></a>
<p></p>
<h4>$page = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 175]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>page number</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$PageAnnots"></a>
<p></p>
<h4>$PageAnnots = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 362]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>of Annotations in pages</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>array</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$PageBreakTrigger"></a>
<p></p>
<h4>$PageBreakTrigger = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 454]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>used to trigger page breaks</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>threshold</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$pagedim"></a>
<p></p>
<h4>$pagedim = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 223]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>that stores page dimensions and graphic status.<ul><li>$this-&gt;pagedim[$this-&gt;page]['w'] =&gt; page_width_in_points</li><li>$this-&gt;pagedim[$this-&gt;page]['h'] =&gt; height in points</li><li>$this-&gt;pagedim[$this-&gt;page]['wk'] =&gt; page_width_in_points</li><li>$this-&gt;pagedim[$this-&gt;page]['hk'] =&gt; height</li><li>$this-&gt;pagedim[$this-&gt;page]['tm'] =&gt; top_margin</li><li>$this-&gt;pagedim[$this-&gt;page]['bm'] =&gt; bottom_margin</li><li>$this-&gt;pagedim[$this-&gt;page]['lm'] =&gt; left_margin</li><li>$this-&gt;pagedim[$this-&gt;page]['rm'] =&gt; right_margin</li><li>$this-&gt;pagedim[$this-&gt;page]['pb'] =&gt; auto_page_break</li><li>$this-&gt;pagedim[$this-&gt;page]['or'] =&gt; page_orientation</li><li>$this-&gt;pagedim[$this-&gt;page]['olm'] =&gt; original_left_margin</li><li>$this-&gt;pagedim[$this-&gt;page]['orm'] =&gt; original_right_margin</li></ul></td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>array</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$pagegroups"></a>
<p></p>
<h4>$pagegroups = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 901]</p>
2009-03-24 18:37:18 +00:00
Contains the number of pages of the groups<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$pagelen"></a>
<p></p>
<h4>$pagelen = <span class="value">array()</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1179]</p>
2010-01-19 08:38:30 +00:00
Array containing page lengths in bytes.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2008-12-31)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$PageMode"></a>
<p></p>
<h4>$PageMode = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 964]</p>
2009-03-24 18:37:18 +00:00
A name object specifying how the document should be displayed when opened.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-06-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$pageopen"></a>
<p></p>
<h4>$pageopen = <span class="value">array()</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1235]</p>
2009-03-24 18:37:18 +00:00
Store the fage status (true when opened, false when closed).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2009-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$pages"></a>
<p></p>
<h4>$pages = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 199]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>containing pages</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>array</td>
2009-08-29 16:09:18 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$page_obj_id"></a>
<p></p>
<h4>$page_obj_id = <span class="value">array()</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1347]</p>
2009-08-29 16:09:18 +00:00
ID of page objects<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.7.000 (2009-08-29)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$PDFVersion"></a>
<p></p>
<h4>$PDFVersion = <span class="value">&nbsp;'1.7'</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 553]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>version</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.5.3</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>PDF</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$premode"></a>
<p></p>
<h4>$premode = <span class="value">&nbsp;false</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1143]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>true when inside html pre tag</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.4.001 (2008-12-08)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>boolean</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$print_footer"></a>
<p></p>
<h4>$print_footer = <span class="value">&nbsp;true</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 618]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>true prints footer.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>If</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$print_header"></a>
<p></p>
<h4>$print_header = <span class="value">&nbsp;true</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 612]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>true prints header</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>If</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$Pvalue"></a>
<p></p>
<h4>$Pvalue = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 769]</p>
2009-03-24 18:37:18 +00:00
P entry in pdf document<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000 (2008-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-09-09 21:21:25 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$radiobutton_groups"></a>
<p></p>
<h4>$radiobutton_groups = <span class="value">array()</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1459]</p>
2009-09-09 21:21:25 +00:00
List of radio buttons parent objects.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.001 (2009-09-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$radio_groups"></a>
<p></p>
<h4>$radio_groups = <span class="value">array()</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1466]</p>
2009-09-09 21:21:25 +00:00
List of radio group objects IDs<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.001 (2009-09-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-04-28 08:12:11 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$re_spaces"></a>
<p></p>
2009-06-15 12:18:24 +00:00
<h4>$re_spaces = <span class="value">&nbsp;'/[\s]/'</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1319]</p>
2009-04-28 08:12:11 +00:00
Regular expression used to find blank characters used for word-wrapping.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.6.006 (2009-04-28)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-03-24 18:37:18 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$rMargin"></a>
<p></p>
<h4>$rMargin = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 283]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>margin</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>right</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$rtl"></a>
<p></p>
<h4>$rtl = <span class="value">&nbsp;false</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 732]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>if the document language is Right-To-Left</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>indicates</td>
2009-04-25 08:54:01 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$sign"></a>
<p></p>
<h4>$sign = <span class="value">&nbsp;false</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1298]</p>
2009-04-25 08:54:01 +00:00
If true enables document signing<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.6.005 (2009-04-24)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$signature_data"></a>
<p></p>
<h4>$signature_data = <span class="value">array()</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1305]</p>
2009-04-25 08:54:01 +00:00
Signature data<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.6.005 (2009-04-24)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
2010-01-19 08:38:30 +00:00
<a name="var$signature_max_length"></a>
2009-04-25 08:54:01 +00:00
<p></p>
2010-01-19 08:38:30 +00:00
<h4>$signature_max_length = <span class="value">&nbsp;11742</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1312]</p>
2010-01-19 08:38:30 +00:00
Signature max length<br /><br /><br /><br />
2009-04-25 08:54:01 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.6.005 (2009-04-24)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-08-25 18:07:52 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$sig_annot_ref"></a>
<p></p>
2009-08-29 16:09:18 +00:00
<h4>$sig_annot_ref = <span class="value">&nbsp;'***SIGANNREF***&nbsp;0&nbsp;R'</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1340]</p>
2009-08-25 18:07:52 +00:00
Placemark used during signature process.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.6.028 (2009-08-25)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-07-23 23:08:13 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$sig_obj_id"></a>
<p></p>
<h4>$sig_obj_id = <span class="value">&nbsp;0</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1326]</p>
2009-07-23 23:08:13 +00:00
Signature object ID<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.6.022 (2009-06-23)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-04-25 08:54:01 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$spot_colors"></a>
<p></p>
<h4>$spot_colors = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 1065]</p>
2009-03-24 18:37:18 +00:00
Array of Spot colors<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.024 (2008-09-12)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-09-23 17:10:28 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$start_transaction_page"></a>
<p></p>
<h4>$start_transaction_page = <span class="value">&nbsp;0</span></h4>
<p>[line 1480]</p>
Store page number when startTransaction() is called.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.006 (2009-09-23)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-03-24 18:37:18 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$state"></a>
<p></p>
<h4>$state = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 205]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>document state</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$subject"></a>
<p></p>
2009-04-16 15:53:29 +00:00
<h4>$subject = <span class="value">&nbsp;''</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 484]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>subject</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$tagvspaces"></a>
<p></p>
<h4>$tagvspaces = <span class="value">array()</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1114]</p>
2009-03-24 18:37:18 +00:00
Array used for custom vertical spaces for HTML tags<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.2.001 (2008-10-30)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$tempfontsize"></a>
<p></p>
<h4>$tempfontsize = <span class="value">&nbsp;10</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 705]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>temporary font size in points.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>Store</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$TextColor"></a>
<p></p>
<h4>$TextColor = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 436]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>for text color</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>commands</td>
2009-09-23 17:10:28 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$textindent"></a>
<p></p>
<h4>$textindent = <span class="value">&nbsp;0</span></h4>
<p>[line 1473]</p>
Text indentation value (used for text-indent CSS attribute)<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.006 (2009-09-23)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$thead"></a>
<p></p>
<h4>$thead = <span class="value">&nbsp;''</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1263]</p>
2009-03-24 18:37:18 +00:00
Table header content to be repeated on each new page<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.030 (2009-03-20)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
2009-06-04 12:29:52 +00:00
<a name="var$theadMargins"></a>
2009-03-24 18:37:18 +00:00
<p></p>
2009-06-04 12:29:52 +00:00
<h4>$theadMargins = <span class="value">array()</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1270]</p>
2009-06-04 12:29:52 +00:00
Margins used for table header.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.030 (2009-03-20)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$title"></a>
<p></p>
2009-04-16 15:53:29 +00:00
<h4>$title = <span class="value">&nbsp;''</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 478]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>title</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$tMargin"></a>
<p></p>
<h4>$tMargin = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 277]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>margin</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>top</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$tmprtl"></a>
<p></p>
<h4>$tmprtl = <span class="value">&nbsp;false</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 739]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>to force RTL or LTR string inversion</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>used</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$transfmatrix"></a>
<p></p>
<h4>$transfmatrix = <span class="value">array()</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 1086]</p>
2009-03-24 18:37:18 +00:00
Array of transformation matrix<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.2.000 (2008-10-29)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-09-17 20:37:43 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$transfmatrix_key"></a>
<p></p>
<h4>$transfmatrix_key = <span class="value">&nbsp;0</span></h4>
<p>[line 1093]</p>
Current key for transformation matrix<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.005 (2009-09-17)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
2009-03-24 18:37:18 +00:00
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$transfmrk"></a>
<p></p>
<h4>$transfmrk = <span class="value">array()</span></h4>
2009-09-17 20:37:43 +00:00
<p>[line 1151]</p>
2009-03-24 18:37:18 +00:00
Array used to store positions of graphics transformation blocks inside the page buffer.<br /><br /><p>keys are the page numbers</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.4.002 (2008-12-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$underline"></a>
<p></p>
<h4>$underline = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 400]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>flag</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>underlining</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$ur"></a>
<p></p>
<h4>$ur = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 852]</p>
2009-03-24 18:37:18 +00:00
If true enables user's rights on PDF reader<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.9.000 (2008-03-26)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$ur_annots"></a>
<p></p>
<h4>$ur_annots = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 866]</p>
2009-03-24 18:37:18 +00:00
Names specifying additional annotation-related usage rights for the document.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.9.000 (2008-03-26)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$ur_document"></a>
<p></p>
<h4>$ur_document = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 859]</p>
2009-03-24 18:37:18 +00:00
Names specifying additional document-wide usage rights for the document.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.9.000 (2008-03-26)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$ur_form"></a>
<p></p>
<h4>$ur_form = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 873]</p>
2009-03-24 18:37:18 +00:00
Names specifying additional form-field-related usage rights for the document.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.9.000 (2008-03-26)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$ur_signature"></a>
<p></p>
<h4>$ur_signature = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 880]</p>
2009-03-24 18:37:18 +00:00
Names specifying additional signature-related usage rights for the document.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.9.000 (2008-03-26)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$Uvalue"></a>
<p></p>
<h4>$Uvalue = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 755]</p>
2009-03-24 18:37:18 +00:00
U entry in pdf document<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000 (2008-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$viewer_preferences"></a>
<p></p>
<h4>$viewer_preferences = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 957]</p>
2009-03-24 18:37:18 +00:00
PDF viewer preferences.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-06-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$visibility"></a>
<p></p>
<h4>$visibility = <span class="value">&nbsp;'all'</span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 915]</p>
2009-03-24 18:37:18 +00:00
Restrict the rendering of some elements to screen or printout.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$w"></a>
<p></p>
<h4>$w = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 259]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>width of page in user unit</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$wPt"></a>
<p></p>
<h4>$wPt = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 247]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>width of page in points</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$x"></a>
<p></p>
<h4>$x = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 308]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>horizontal position in user unit for cell positioning</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$y"></a>
<p></p>
<h4>$y = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 314]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>vertical position in user unit for cell positioning</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>current</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$ZoomMode"></a>
<p></p>
<h4>$ZoomMode = <span class="value"></span></h4>
2009-08-29 12:54:16 +00:00
<p>[line 466]</p>
2009-03-24 18:37:18 +00:00
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>display mode</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>zoom</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
</div><br />
<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">
<hr />
<a name="method__construct"></a>
2010-01-25 17:14:23 +00:00
<h3>constructor __construct <span class="smalllinenumber">[line 1506]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>TCPDF __construct(
[string
$orientation = 'P'], [string
$unit = 'mm'], [mixed
$format = 'A4'], [boolean
$unicode = true], [String
$encoding = 'UTF-8'], [boolean
$diskcache = false])</code>
</td></tr></table>
</td></tr></table><br />
This is the class constructor.<br /><br /><p>It allows to set up the page format, the orientation and the measure unit used in all the methods (except for the font sizes).</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$orientation</b>&nbsp;&nbsp;</td>
<td>page orientation. Possible values are (case insensitive):<ul><li>P or Portrait (default)</li><li>L or Landscape</li></ul></td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$unit</b>&nbsp;&nbsp;</td>
<td>User measure unit. Possible values are:<ul><li>pt: point</li><li>mm: millimeter (default)</li><li>cm: centimeter</li><li>in: inch</li></ul><br />A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.</td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$format</b>&nbsp;&nbsp;</td>
<td>The format used for pages. It can be either one of the following values (case insensitive) or a custom format in the form of a two-element array containing the width and the height (expressed in the unit given by unit).<ul><li>4A0</li><li>2A0</li><li>A0</li><li>A1</li><li>A2</li><li>A3</li><li>A4 (default)</li><li>A5</li><li>A6</li><li>A7</li><li>A8</li><li>A9</li><li>A10</li><li>B0</li><li>B1</li><li>B2</li><li>B3</li><li>B4</li><li>B5</li><li>B6</li><li>B7</li><li>B8</li><li>B9</li><li>B10</li><li>C0</li><li>C1</li><li>C2</li><li>C3</li><li>C4</li><li>C5</li><li>C6</li><li>C7</li><li>C8</li><li>C9</li><li>C10</li><li>RA0</li><li>RA1</li><li>RA2</li><li>RA3</li><li>RA4</li><li>SRA0</li><li>SRA1</li><li>SRA2</li><li>SRA3</li><li>SRA4</li><li>LETTER</li><li>LEGAL</li><li>EXECUTIVE</li><li>FOLIO</li></ul></td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$unicode</b>&nbsp;&nbsp;</td>
<td>TRUE means that the input text is unicode (default = true)</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$diskcache</b>&nbsp;&nbsp;</td>
<td>if TRUE reduce the RAM memory usage by caching temporary data on filesystem (slower).</td>
</tr>
<tr>
<td class="type">String&nbsp;&nbsp;</td>
<td><b>$encoding</b>&nbsp;&nbsp;</td>
<td>charset encoding; default is UTF-8</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method__destruct"></a>
2010-01-25 17:14:23 +00:00
<h3>destructor __destruct <span class="smalllinenumber">[line 1632]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void __destruct(
)</code>
</td></tr></table>
</td></tr></table><br />
Default destructor.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.53.0.TC016</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodAcceptPageBreak"></a>
2010-03-13 19:49:15 +00:00
<h3>method AcceptPageBreak <span class="smalllinenumber">[line 3644]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean AcceptPageBreak(
)</code>
</td></tr></table>
</td></tr></table><br />
Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value.<br /><br /><p>The default implementation returns a value according to the mode selected by SetAutoPageBreak().<br /> This method is called automatically and should not be called directly by the application.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetAutoPageBreak">TCPDF::SetAutoPageBreak()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.4</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodaddExtGState"></a>
2010-03-20 13:26:55 +00:00
<h3>method addExtGState <span class="smalllinenumber">[line 11536]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
2010-01-14 14:02:19 +00:00
<code>the addExtGState(
2009-03-24 18:37:18 +00:00
2010-01-14 14:02:19 +00:00
$parms, array
$params)</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Add transparency parameters to the current extgstate<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>number of extgstates</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$params</b>&nbsp;&nbsp;</td>
<td>parameters</td>
</tr>
<tr>
2009-03-24 18:37:18 +00:00
<td class="type">&nbsp;&nbsp;</td>
<td><b>$parms</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodAddFont"></a>
2010-03-13 19:49:15 +00:00
<h3>method AddFont <span class="smalllinenumber">[line 3196]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array AddFont(
string
$family, [string
$style = ''], [string
$fontfile = ''])</code>
</td></tr></table>
</td></tr></table><br />
Imports a TrueType, Type1, core, or CID0 font and makes it available.<br /><br /><p>It is necessary to generate a font definition file first (read /fonts/utils/README.TXT). The definition file (and the font file itself when embedding) must be present either in the current directory or in the one indicated by K_PATH_FONTS if the constant is defined. If it could not be found, the error &quot;Could not include font definition file&quot; is generated.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>containing the font data, or false in case of error.</td>
</tr>
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFont">TCPDF::SetFont()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.5</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$family</b>&nbsp;&nbsp;</td>
<td>Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>Font style. Possible values are (case insensitive):<ul><li>empty string: regular (default)</li><li>B: bold</li><li>I: italic</li><li>BI or IB: bold italic</li></ul></td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$fontfile</b>&nbsp;&nbsp;</td>
<td>The font definition file. By default, the name is built from the family and style, in lower case with no spaces.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodaddHtmlLink"></a>
2010-03-20 13:26:55 +00:00
<h3>method addHtmlLink <span class="smalllinenumber">[line 7905]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>the addHtmlLink(
string
$url, string
$name, [int
$fill = 0], [boolean
$firstline = false], [array
$color = ''], [string
2010-03-13 19:49:15 +00:00
$style = -1], [boolean
$firstblock = false])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
Output anchor link.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>number of cells used or the remaining text if $firstline = true;</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$url</b>&nbsp;&nbsp;</td>
<td>link URL or internal link (i.e.: &amp;lt;a href=&quot;#23&quot;&amp;gt;link to page 23&amp;lt;/a&amp;gt;)</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$name</b>&nbsp;&nbsp;</td>
<td>link name</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$fill</b>&nbsp;&nbsp;</td>
<td>Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$firstline</b>&nbsp;&nbsp;</td>
<td>if true prints only the first line and return the remaining string.</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$color</b>&nbsp;&nbsp;</td>
<td>array of RGB text color</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>font style (U, D, B, I)</td>
2010-03-13 19:49:15 +00:00
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$firstblock</b>&nbsp;&nbsp;</td>
<td>if true the string is the starting of a line.</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodaddHTMLVertSpace"></a>
2010-03-20 13:26:55 +00:00
<h3>method addHTMLVertSpace <span class="smalllinenumber">[line 15302]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void addHTMLVertSpace(
int
$n, [boolean
$cell = false], [string
$h = ''], [boolean
$firstorlast = false], [string
$tag = ''], [boolean
$closing = false])</code>
</td></tr></table>
</td></tr></table><br />
Add vertical spaces if needed.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$n</b>&nbsp;&nbsp;</td>
<td>number of spaces to add</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$cell</b>&nbsp;&nbsp;</td>
<td>if true add the default cMargin space to each new line (default false).</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>The height of the break. By default, the value equals the height of the last printed cell.</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$firstorlast</b>&nbsp;&nbsp;</td>
<td>if true do not print additional empty lines.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$tag</b>&nbsp;&nbsp;</td>
<td>HTML tag to which this space will be applied</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$closing</b>&nbsp;&nbsp;</td>
<td>true if this space will be applied to a closing tag, false otherwise</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-09-07 21:53:40 +00:00
<hr />
<a name="methodaddJavascriptObject"></a>
2010-03-20 13:26:55 +00:00
<h3>method addJavascriptObject <span class="smalllinenumber">[line 10156]</span></h3>
2009-09-07 21:53:40 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
2010-01-14 14:02:19 +00:00
<code>int addJavascriptObject(
string
$script, [boolean
2009-09-07 21:53:40 +00:00
$onload = false])</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Adds a javascript object and return object ID<br /><br /><br /><br />
2009-09-07 21:53:40 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>internal object ID</td>
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.000 (2009-09-07)</td>
</tr>
2009-09-07 21:53:40 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$script</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Javascript code</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">boolean&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$onload</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>if true executes this object when opening the document</td>
2009-09-07 21:53:40 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="methodAddLink"></a>
2010-03-13 19:49:15 +00:00
<h3>method AddLink <span class="smalllinenumber">[line 3437]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void AddLink(
)</code>
</td></tr></table>
</td></tr></table><br />
Creates a new internal link and returns its identifier. An internal link is a clickable area which directs to another place within the document.<br /> The identifier can then be passed to Cell(), Write(), Image() or Link(). The destination is defined with SetLink().<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodWrite">TCPDF::Write()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodImage">TCPDF::Image()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodLink">TCPDF::Link()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLink">TCPDF::SetLink()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.5</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodAddPage"></a>
2010-03-13 19:49:15 +00:00
<h3>method AddPage <span class="smalllinenumber">[line 2392]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void AddPage(
[string
$orientation = ''], [mixed
2010-03-13 19:49:15 +00:00
$format = ''], [boolean
$keepmargins = false])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
Adds a new page to the document. If a page is already present, the Footer() method is called first to output the footer (if enabled). Then the page is added, the current position set to the top-left corner according to the left and top margins (or top-right if in RTL mode), and Header() is called to display the header (if enabled).<br /><br /><p>The origin of the coordinate system is at the top-left corner (or top-right for RTL) and increasing ordinates go downwards.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodstartPage">TCPDF::startPage()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodendPage">TCPDF::endPage()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$orientation</b>&nbsp;&nbsp;</td>
<td>page orientation. Possible values are (case insensitive):<ul><li>P or PORTRAIT (default)</li><li>L or LANDSCAPE</li></ul></td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$format</b>&nbsp;&nbsp;</td>
<td>The format used for pages. It can be either one of the following values (case insensitive) or a custom format in the form of a two-element array containing the width and the height (expressed in the unit given by unit).<ul><li>4A0</li><li>2A0</li><li>A0</li><li>A1</li><li>A2</li><li>A3</li><li>A4 (default)</li><li>A5</li><li>A6</li><li>A7</li><li>A8</li><li>A9</li><li>A10</li><li>B0</li><li>B1</li><li>B2</li><li>B3</li><li>B4</li><li>B5</li><li>B6</li><li>B7</li><li>B8</li><li>B9</li><li>B10</li><li>C0</li><li>C1</li><li>C2</li><li>C3</li><li>C4</li><li>C5</li><li>C6</li><li>C7</li><li>C8</li><li>C9</li><li>C10</li><li>RA0</li><li>RA1</li><li>RA2</li><li>RA3</li><li>RA4</li><li>SRA0</li><li>SRA1</li><li>SRA2</li><li>SRA3</li><li>SRA4</li><li>LETTER</li><li>LEGAL</li><li>EXECUTIVE</li><li>FOLIO</li></ul></td>
2010-03-13 19:49:15 +00:00
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$keepmargins</b>&nbsp;&nbsp;</td>
<td>if true overwrites the default page margins with the current margins</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodAddSpotColor"></a>
2010-03-13 19:49:15 +00:00
<h3>method AddSpotColor <span class="smalllinenumber">[line 2818]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void AddSpotColor(
$name, int
$c, int
$m, int
$y, int
$k)</code>
</td></tr></table>
</td></tr></table><br />
Defines a new spot color.<br /><br /><p>It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetDrawSpotColor">TCPDF::SetDrawSpotColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFillSpotColor">TCPDF::SetFillSpotColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTextSpotColor">TCPDF::SetTextSpotColor()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.024 (2008-09-12)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$c</b>&nbsp;&nbsp;</td>
<td>Cyan color for CMYK. Value between 0 and 255</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$m</b>&nbsp;&nbsp;</td>
<td>Magenta color for CMYK. Value between 0 and 255</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>Yellow color for CMYK. Value between 0 and 255</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$k</b>&nbsp;&nbsp;</td>
<td>Key (Black) color for CMYK. Value between 0 and 255</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$name</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodaddTOC"></a>
2010-03-20 13:26:55 +00:00
<h3>method addTOC <span class="smalllinenumber">[line 16326]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void addTOC(
[int
$page = ''], [string
$numbersfont = ''], [string
2009-10-21 12:23:41 +00:00
$filler = '.'], [string
$toc_name = 'TOC'])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
2010-01-27 19:23:46 +00:00
Output a Table of Content Index (TOC).<br /><br /><p>After calling this method you have to call addPage() to add other content. You can override this method to achieve different styles.</p><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2009-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$page</b>&nbsp;&nbsp;</td>
<td>page number where this TOC should be inserted (leave empty for current page).</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$numbersfont</b>&nbsp;&nbsp;</td>
<td>set the font for page numbers (please use monospaced font for better alignment).</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$filler</b>&nbsp;&nbsp;</td>
<td>string used to fill the space between text and page number.</td>
2009-10-21 12:23:41 +00:00
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$toc_name</b>&nbsp;&nbsp;</td>
<td>name to use for TOC bookmark.</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodAliasNbPages"></a>
2010-03-20 13:26:55 +00:00
<h3>method AliasNbPages <span class="smalllinenumber">[line 11344]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void AliasNbPages(
[string
$alias = '{nb}'])</code>
</td></tr></table>
</td></tr></table><br />
Defines an alias for the total number of pages.<br /><br /><p>It will be substituted as the document is closed.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetAliasNbPages">TCPDF::getAliasNbPages()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodPageNo">TCPDF::PageNo()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodFooter">TCPDF::Footer()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.4</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$alias</b>&nbsp;&nbsp;</td>
<td>The alias.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodAliasNumPage"></a>
2010-03-20 13:26:55 +00:00
<h3>method AliasNumPage <span class="smalllinenumber">[line 11371]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void AliasNumPage(
[string
$alias = '{pnb}'])</code>
</td></tr></table>
</td></tr></table><br />
Defines an alias for the page number.<br /><br /><p>It will be substituted as the document is closed.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetAliasNbPages">TCPDF::getAliasNbPages()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodPageNo">TCPDF::PageNo()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodFooter">TCPDF::Footer()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2009-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$alias</b>&nbsp;&nbsp;</td>
<td>The alias.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodAnnotation"></a>
2010-03-13 19:49:15 +00:00
<h3>method Annotation <span class="smalllinenumber">[line 3493]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Annotation(
2009-09-07 21:53:40 +00:00
[float
$x = ''], [float
$y = ''], float
2009-03-24 18:37:18 +00:00
$w, float
$h, string
$text, [array
$opt = array('Subtype'=&gt;'Text')], [int
$spaces = 0])</code>
</td></tr></table>
</td></tr></table><br />
Puts a markup annotation on a rectangular area of the page.<br /><br /><p>!!!!THE ANNOTATION SUPPORT IS NOT YET FULLY IMPLEMENTED !!!!</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.018 (2008-08-06)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>Abscissa of the upper-left corner of the rectangle</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>Ordinate of the upper-left corner of the rectangle</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>Width of the rectangle</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>Height of the rectangle</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$text</b>&nbsp;&nbsp;</td>
<td>annotation text or alternate content</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$opt</b>&nbsp;&nbsp;</td>
<td>array of options (see section 8.4 of PDF reference 1.7).</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$spaces</b>&nbsp;&nbsp;</td>
<td>number of spaces on the text to link</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-07-10 15:38:54 +00:00
<hr />
<a name="methodArrow"></a>
2010-03-20 13:26:55 +00:00
<h3>method Arrow <span class="smalllinenumber">[line 9398]</span></h3>
2009-07-10 15:38:54 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Arrow(
float
$x0, float
$y0,
$x1, float
$y1, [int
$head_style = 0], [float
$arm_size = 5], [int
$arm_angle = 15])</code>
</td></tr></table>
</td></tr></table><br />
Draws a grahic arrow.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2009-08-30 08:53:38 +00:00
<td><b>author:</b>&nbsp;&nbsp;</td><td>Piotr Galecki, Nicola Asuni, Andy Meier</td>
2009-07-10 15:38:54 +00:00
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.6.018 (2009-07-10)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x0</b>&nbsp;&nbsp;</td>
<td>Abscissa of second point.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y0</b>&nbsp;&nbsp;</td>
<td>Ordinate of first point.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y1</b>&nbsp;&nbsp;</td>
<td>Ordinate of second point.</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$head_style</b>&nbsp;&nbsp;</td>
2009-08-30 08:53:38 +00:00
<td>(0 = draw only arrowhead arms, 1 = draw closed arrowhead, but no fill, 2 = closed and filled arrowhead, 3 = filled arrowhead)</td>
2009-07-10 15:38:54 +00:00
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$arm_size</b>&nbsp;&nbsp;</td>
<td>length of arrowhead arms</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$arm_angle</b>&nbsp;&nbsp;</td>
<td>angle between an arm and the shaft</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$x1</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="methodarrUTF8ToUTF16BE"></a>
2010-03-20 13:26:55 +00:00
<h3>method arrUTF8ToUTF16BE <span class="smalllinenumber">[line 7802]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string arrUTF8ToUTF16BE(
array
$unicode, [boolean
$setbom = true])</code>
</td></tr></table>
</td></tr></table><br />
Converts array of UTF-8 characters to UTF16-BE string.<br /><br /><br /><p>Based on: http://www.faqs.org/rfcs/rfc2781.html <pre> Encoding UTF-16:
Encoding of a single character from an ISO 10646 character value to
UTF-16 proceeds as follows. Let U be the character number, no greater
than 0x10FFFF.
1) If U < 0x10000, encode U as a 16-bit unsigned integer and
terminate.
2) Let U' = U - 0x10000. Because U is less than or equal to 0x10FFFF,
U' must be less than or equal to 0xFFFFF. That is, U' can be
represented in 20 bits.
3) Initialize two 16-bit unsigned integers, W1 and W2, to 0xD800 and
0xDC00, respectively. These integers each have 10 bits free to
encode the character value, for a total of 20 bits.
4) Assign the 10 high-order bits of the 20-bit U' to the 10 low-order
bits of W1 and the 10 low-order bits of U' to the 10 low-order
bits of W2. Terminate.
Graphically, steps 2 through 4 look like:
U' = yyyyyyyyyyxxxxxxxxxx
W1 = 110110yyyyyyyyyy
W2 = 110111xxxxxxxxxx</pre></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodUTF8ToUTF16BE">TCPDF::UTF8ToUTF16BE()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-08)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$unicode</b>&nbsp;&nbsp;</td>
<td>array containing UTF-8 unicode values</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$setbom</b>&nbsp;&nbsp;</td>
<td>if true set the Byte Order Mark (BOM = 0xFEFF)</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodBookmark"></a>
2010-03-20 13:26:55 +00:00
<h3>method Bookmark <span class="smalllinenumber">[line 10042]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Bookmark(
2010-01-14 14:02:19 +00:00
string
$txt, [int
$level = 0], [float
$y = -1], [int
2009-03-24 18:37:18 +00:00
$page = ''])</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Adds a bookmark.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Olivier Plathey, Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.002 (2008-02-12)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$txt</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>bookmark description.</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$level</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>bookmark level (minimum value is 0).</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$y</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Ordinate of the boorkmark position (default = -1 = current position).</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$page</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>target page number (leave empty for current page).</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodButton"></a>
2010-03-20 13:26:55 +00:00
<h3>method Button <span class="smalllinenumber">[line 11050]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Button(
2010-01-14 14:02:19 +00:00
string
$name, int
$w, int
$h, string
$caption, mixed
$action, [array
$prop = array()], [array
$opt = array()], [float
$x = ''], [float
$y = ''], [boolean
2009-09-07 21:53:40 +00:00
$js = false])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Creates a button field<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.000 (2009-09-07)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$name</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>field name</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$w</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>width</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$h</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>height</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$caption</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>caption.</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">mixed&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$action</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>action triggered by pressing the button. Use a string to specify a javascript action. Use an array to specify a form action options as on section 12.7.5 of PDF32000_2008.</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$prop</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>javascript field properties. Possible values are described on official Javascript for Acrobat API reference.</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$opt</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>annotation parameters. Possible values are described on official PDF32000_2008 reference.</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$x</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Abscissa of the upper-left corner of the rectangle</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$y</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Ordinate of the upper-left corner of the rectangle</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">boolean&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$js</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>if true put the field using JavaScript (requires Acrobat Writer to be rendered).</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodCell"></a>
2010-03-13 19:49:15 +00:00
<h3>method Cell <span class="smalllinenumber">[line 3705]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Cell(
float
$w, [float
$h = 0], [string
$txt = ''], [mixed
$border = 0], [int
$ln = 0], [string
$align = ''], [int
$fill = 0], [mixed
$link = ''], [int
2009-03-27 18:23:22 +00:00
$stretch = 0], [boolean
$ignore_min_height = false])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
Prints a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.<br /> If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFont">TCPDF::SetFont()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetDrawColor">TCPDF::SetDrawColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFillColor">TCPDF::SetFillColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTextColor">TCPDF::SetTextColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineWidth">TCPDF::SetLineWidth()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodAddLink">TCPDF::AddLink()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodLn">TCPDF::Ln()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodMultiCell">TCPDF::MultiCell()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodWrite">TCPDF::Write()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetAutoPageBreak">TCPDF::SetAutoPageBreak()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>Cell width. If 0, the cell extends up to the right margin.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>Cell height. Default value: 0.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$txt</b>&nbsp;&nbsp;</td>
<td>String to print. Default value: empty string.</td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$border</b>&nbsp;&nbsp;</td>
<td>Indicates if borders must be drawn around the cell. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul></td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$ln</b>&nbsp;&nbsp;</td>
<td>Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL languages)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul></td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$align</b>&nbsp;&nbsp;</td>
<td>Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul></td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$fill</b>&nbsp;&nbsp;</td>
<td>Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.</td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$link</b>&nbsp;&nbsp;</td>
<td>URL or identifier returned by AddLink().</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$stretch</b>&nbsp;&nbsp;</td>
<td>stretch carachter mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if necessary</li><li>4 = forced character spacing</li></ul></td>
2009-03-27 18:23:22 +00:00
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$ignore_min_height</b>&nbsp;&nbsp;</td>
<td>if true ignore automatic minimum height value.</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodCheckBox"></a>
2010-03-20 13:26:55 +00:00
<h3>method CheckBox <span class="smalllinenumber">[line 10980]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void CheckBox(
2010-01-14 14:02:19 +00:00
string
$name, int
$w, [boolean
$checked = false], [array
$prop = array()], [array
$opt = array()], [string
$onvalue = 'Yes'], [float
$x = ''], [float
$y = ''], [boolean
2009-09-07 21:53:40 +00:00
$js = false])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Creates a CheckBox field<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.000 (2009-09-07)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$name</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>field name</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$w</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>width</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">boolean&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$checked</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>define the initial state.</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$prop</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>javascript field properties. Possible values are described on official Javascript for Acrobat API reference.</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$opt</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>annotation parameters. Possible values are described on official PDF32000_2008 reference.</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$onvalue</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>value to be returned if selected.</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$x</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Abscissa of the upper-left corner of the rectangle</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$y</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Ordinate of the upper-left corner of the rectangle</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">boolean&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$js</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>if true put the field using JavaScript (requires Acrobat Writer to be rendered).</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodcheckPageBreak"></a>
2010-03-13 19:49:15 +00:00
<h3>method checkPageBreak <span class="smalllinenumber">[line 3657]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean checkPageBreak(
2009-05-17 19:39:28 +00:00
[float
$h = 0], [mixed
2009-07-05 20:06:07 +00:00
$y = ''], [boolean
$addpage = true])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
Add page if needed.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>true in case of page break, false otherwise.</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.2.000 (2008-07-01)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>Cell height. Default value: 0.</td>
2009-05-17 19:39:28 +00:00
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>starting y position, leave empty for current position.</td>
2009-07-05 20:00:18 +00:00
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$addpage</b>&nbsp;&nbsp;</td>
2009-07-05 20:06:07 +00:00
<td>if true add a page, otherwise only return the true/false state</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodCircle"></a>
2010-03-20 13:26:55 +00:00
<h3>method Circle <span class="smalllinenumber">[line 9032]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Circle(
float
$x0, float
$y0, float
$r, [
$astart = 0], [
$afinish = 360], [string
$style = ''], [array
$line_style = array()], [array
$fill_color = array()], [integer
$nc = 8], float
$astart:, float
$afinish:)</code>
</td></tr></table>
</td></tr></table><br />
Draws a circle.<br /><br /><p>A circle is formed from n Bezier curves.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-08)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x0</b>&nbsp;&nbsp;</td>
<td>Abscissa of center point.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y0</b>&nbsp;&nbsp;</td>
<td>Ordinate of center point.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$r</b>&nbsp;&nbsp;</td>
<td>Radius.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$astart:</b>&nbsp;&nbsp;</td>
<td>Angle start of draw line. Default value: 0.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$afinish:</b>&nbsp;&nbsp;</td>
<td>Angle finish of draw line. Default value: 360.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>Style of rendering. Possible values are: <ul><li>D or empty string: Draw (default).</li><li>F: Fill.</li><li>DF or FD: Draw and fill.</li><li>C: Draw close.</li><li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li><li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li></ul></td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$line_style</b>&nbsp;&nbsp;</td>
<td>Line style of circle. Array like for <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">SetLineStyle</a>. Default value: default line style (empty array).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$fill_color</b>&nbsp;&nbsp;</td>
<td>Fill color. Format: array(red, green, blue). Default value: default color (empty array).</td>
</tr>
<tr>
<td class="type">integer&nbsp;&nbsp;</td>
<td><b>$nc</b>&nbsp;&nbsp;</td>
<td>Number of curves used in circle. Default value: 8.</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$astart</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$afinish</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodClip"></a>
2010-03-20 13:26:55 +00:00
<h3>method Clip <span class="smalllinenumber">[line 11792]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Clip(
float
$x, float
$y, float
$w, float
$h)</code>
</td></tr></table>
</td></tr></table><br />
Set a rectangular clipping area.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Andreas W<>rmser, Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-06-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>abscissa of the top left corner of the rectangle (or top right corner for RTL mode).</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>ordinate of the top left corner of the rectangle.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>width of the rectangle.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>height of the rectangle.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodClose"></a>
2010-03-13 19:49:15 +00:00
<h3>method Close <span class="smalllinenumber">[line 2285]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Close(
)</code>
</td></tr></table>
</td></tr></table><br />
Terminates the PDF document.<br /><br /><p>It is not necessary to call this method explicitly because Output() does it automatically. If the document contains no page, AddPage() is called to prevent from getting an invalid document.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodOpen">TCPDF::Open()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodOutput">TCPDF::Output()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodcloseHTMLTagHandler"></a>
2010-03-20 13:26:55 +00:00
<h3>method closeHTMLTagHandler <span class="smalllinenumber">[line 14947]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void closeHTMLTagHandler(
&$dom, int
$key, [boolean
$cell = false], array
$dom)</code>
</td></tr></table>
</td></tr></table><br />
Process closing tags.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$dom</b>&nbsp;&nbsp;</td>
<td>html dom array</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$key</b>&nbsp;&nbsp;</td>
<td>current element id</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$cell</b>&nbsp;&nbsp;</td>
<td>if true add the default cMargin space to each new line (default false).</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>&$dom</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodComboBox"></a>
2010-03-20 13:26:55 +00:00
<h3>method ComboBox <span class="smalllinenumber">[line 10919]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void ComboBox(
2010-01-14 14:02:19 +00:00
string
$name, int
$w, int
$h, array
$values, [array
$prop = array()], [array
$opt = array()], [float
$x = ''], [float
$y = ''], [boolean
2009-09-07 21:53:40 +00:00
$js = false])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Creates a Combo-box field<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.000 (2009-09-07)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$name</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>field name</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$w</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>width</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$h</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>height</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$values</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>array containing the list of values.</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$prop</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>javascript field properties. Possible values are described on official Javascript for Acrobat API reference.</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$opt</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>annotation parameters. Possible values are described on official PDF32000_2008 reference.</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$x</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Abscissa of the upper-left corner of the rectangle</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$y</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Ordinate of the upper-left corner of the rectangle</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">boolean&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$js</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>if true put the field using JavaScript (requires Acrobat Writer to be rendered).</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodcommitTransaction"></a>
2010-03-20 13:26:55 +00:00
<h3>method commitTransaction <span class="smalllinenumber">[line 16484]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void commitTransaction(
)</code>
</td></tr></table>
</td></tr></table><br />
2009-04-20 16:18:44 +00:00
Delete the copy of the current TCPDF object used for undo operation.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.029 (2009-03-19)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodconvertHTMLColorToDec"></a>
2010-03-20 13:26:55 +00:00
<h3>method convertHTMLColorToDec <span class="smalllinenumber">[line 7938]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array convertHTMLColorToDec(
[string
2009-04-16 15:53:29 +00:00
$color = '#FFFFFF'])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
Returns an associative array (keys: R,G,B) from an html color name or a six-digit or three-digit hexadecimal color representation (i.e. #3FE5AA or #7FF).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2009-04-16 15:53:29 +00:00
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>RGB color or false in case of error.</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$color</b>&nbsp;&nbsp;</td>
<td>html color</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodCoonsPatchMesh"></a>
2010-03-20 13:26:55 +00:00
<h3>method CoonsPatchMesh <span class="smalllinenumber">[line 11712]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void CoonsPatchMesh(
float
$x, float
$y, float
$w, float
$h, [array
$col1 = array()], [array
$col2 = array()], [array
$col3 = array()], [array
$col4 = array()], [array
$coords = array(0.00,0.0,0.33,0.00,0.67,0.00,1.00,0.00,1.00,0.33,1.00,0.67,1.00,1.00,0.67,1.00,0.33,1.00,0.00,1.00,0.00,0.67,0.00,0.33)], [array
$coords_min = 0], [array
$coords_max = 1])</code>
</td></tr></table>
</td></tr></table><br />
Paints a coons patch mesh.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Andreas W<>rmser, Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-06-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>abscissa of the top left corner of the rectangle.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>ordinate of the top left corner of the rectangle.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>width of the rectangle.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>height of the rectangle.</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$col1</b>&nbsp;&nbsp;</td>
<td>first color (lower left corner) (RGB components).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$col2</b>&nbsp;&nbsp;</td>
<td>second color (lower right corner) (RGB components).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$col3</b>&nbsp;&nbsp;</td>
<td>third color (upper right corner) (RGB components).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$col4</b>&nbsp;&nbsp;</td>
<td>fourth color (upper left corner) (RGB components).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$coords</b>&nbsp;&nbsp;</td>
<td><ul><li>for one patch mesh: array(float x1, float y1, .... float x12, float y12): 12 pairs of coordinates (normally from 0 to 1) which specify the Bezier control points that define the patch. First pair is the lower left edge point, next is its right control point (control point 2). Then the other points are defined in the order: control point 1, edge point, control point 2 going counter-clockwise around the patch. Last (x12, y12) is the first edge point's left control point (control point 1).</li><li>for two or more patch meshes: array[number of patches]: arrays with the following keys for each patch: f: where to put that patch (0 = first patch, 1, 2, 3 = right, top and left of precedent patch - I didn't figure this out completely - just try and error ;-) points: 12 pairs of coordinates of the Bezier control points as above for the first patch, 8 pairs of coordinates for the following patches, ignoring the coordinates already defined by the precedent patch (I also didn't figure out the order of these - also: try and see what's happening) colors: must be 4 colors for the first patch, 2 colors for the following patches</li></ul></td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$coords_min</b>&nbsp;&nbsp;</td>
<td>minimum value used by the coordinates. If a coordinate's value is smaller than this it will be cut to coords_min. default: 0</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$coords_max</b>&nbsp;&nbsp;</td>
<td>maximum value used by the coordinates. If a coordinate's value is greater than this it will be cut to coords_max. default: 1</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodCurve"></a>
2010-03-20 13:26:55 +00:00
<h3>method Curve <span class="smalllinenumber">[line 8807]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Curve(
float
$x0, float
$y0, float
$x1, float
$y1, float
$x2, float
$y2, float
$x3, float
$y3, [string
$style = ''], [array
$line_style = array()], [array
$fill_color = array()])</code>
</td></tr></table>
</td></tr></table><br />
Draws a Bezier curve.<br /><br /><p>The Bezier curve is a tangent to the line between the control points at either end of the curve.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">TCPDF::SetLineStyle()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-08)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x0</b>&nbsp;&nbsp;</td>
<td>Abscissa of start point.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y0</b>&nbsp;&nbsp;</td>
<td>Ordinate of start point.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x1</b>&nbsp;&nbsp;</td>
<td>Abscissa of control point 1.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y1</b>&nbsp;&nbsp;</td>
<td>Ordinate of control point 1.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x2</b>&nbsp;&nbsp;</td>
<td>Abscissa of control point 2.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y2</b>&nbsp;&nbsp;</td>
<td>Ordinate of control point 2.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x3</b>&nbsp;&nbsp;</td>
<td>Abscissa of end point.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y3</b>&nbsp;&nbsp;</td>
<td>Ordinate of end point.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>Style of rendering. Possible values are: <ul><li>D or empty string: Draw (default).</li><li>F: Fill.</li><li>DF or FD: Draw and fill.</li><li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li><li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li></ul></td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$line_style</b>&nbsp;&nbsp;</td>
<td>Line style of curve. Array like for <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">SetLineStyle</a>. Default value: default line style (empty array).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$fill_color</b>&nbsp;&nbsp;</td>
<td>Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-04-23 08:53:25 +00:00
<hr />
<a name="methoddeletePage"></a>
2010-03-20 13:26:55 +00:00
<h3>method deletePage <span class="smalllinenumber">[line 16184]</span></h3>
2009-04-23 08:53:25 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>true deletePage(
int
$page)</code>
</td></tr></table>
</td></tr></table><br />
Remove the specified page.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>in case of success, false in case of error.</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.6.004 (2009-04-23)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$page</b>&nbsp;&nbsp;</td>
<td>page to remove</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="methodEllipse"></a>
2010-03-20 13:26:55 +00:00
<h3>method Ellipse <span class="smalllinenumber">[line 8928]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Ellipse(
float
$x0, float
$y0, float
$rx, [float
$ry = 0], [
$angle = 0], [
$astart = 0], [
$afinish = 360], [string
$style = ''], [array
$line_style = array()], [array
$fill_color = array()], [integer
$nc = 8], float
$angle:, float
$astart:, float
$afinish:)</code>
</td></tr></table>
</td></tr></table><br />
Draws an ellipse.<br /><br /><p>An ellipse is formed from n Bezier curves.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-08)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x0</b>&nbsp;&nbsp;</td>
<td>Abscissa of center point.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y0</b>&nbsp;&nbsp;</td>
<td>Ordinate of center point.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$rx</b>&nbsp;&nbsp;</td>
<td>Horizontal radius.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$ry</b>&nbsp;&nbsp;</td>
<td>Vertical radius (if ry = 0 then is a circle, see <a href="../com-tecnick-tcpdf/TCPDF.html#methodCircle">Circle</a>). Default value: 0.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$angle:</b>&nbsp;&nbsp;</td>
<td>Angle oriented (anti-clockwise). Default value: 0.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$astart:</b>&nbsp;&nbsp;</td>
<td>Angle start of draw line. Default value: 0.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$afinish:</b>&nbsp;&nbsp;</td>
<td>Angle finish of draw line. Default value: 360.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>Style of rendering. Possible values are: <ul><li>D or empty string: Draw (default).</li><li>F: Fill.</li><li>DF or FD: Draw and fill.</li><li>C: Draw close.</li><li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li><li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li></ul></td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$line_style</b>&nbsp;&nbsp;</td>
<td>Line style of ellipse. Array like for <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">SetLineStyle</a>. Default value: default line style (empty array).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$fill_color</b>&nbsp;&nbsp;</td>
<td>Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).</td>
</tr>
<tr>
<td class="type">integer&nbsp;&nbsp;</td>
<td><b>$nc</b>&nbsp;&nbsp;</td>
<td>Number of curves used in ellipse. Default value: 8.</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$angle</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$astart</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$afinish</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-04-16 15:53:29 +00:00
<hr />
<a name="methodempty_string"></a>
2010-03-20 13:26:55 +00:00
<h3>method empty_string <span class="smalllinenumber">[line 16538]</span></h3>
2009-04-16 15:53:29 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean empty_string(
2010-03-13 19:49:15 +00:00
string
2009-04-16 15:53:29 +00:00
$str)</code>
</td></tr></table>
</td></tr></table><br />
Determine whether a string is empty.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>true if string is empty</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.044 (2009-04-16)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-03-13 19:49:15 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-04-16 15:53:29 +00:00
<td><b>$str</b>&nbsp;&nbsp;</td>
<td>string to be checked</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="methodendPage"></a>
2010-03-13 19:49:15 +00:00
<h3>method endPage <span class="smalllinenumber">[line 2411]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void endPage(
)</code>
</td></tr></table>
</td></tr></table><br />
Terminate the current page<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodstartPage">TCPDF::startPage()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodAddPage">TCPDF::AddPage()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.2.010 (2008-11-14)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodError"></a>
2010-03-13 19:49:15 +00:00
<h3>method Error <span class="smalllinenumber">[line 2257]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Error(
string
$msg)</code>
</td></tr></table>
</td></tr></table><br />
This method is automatically called in case of fatal error; it simply outputs the message and halts the execution. An inherited class may override it to customize the error handling but should always halt the script, or the resulting document would probably be invalid.<br /><br /><p>2004-06-11 :: Nicola Asuni : changed bold tag with strong</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$msg</b>&nbsp;&nbsp;</td>
<td>The error message</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodFooter"></a>
2010-03-13 19:49:15 +00:00
<h3>method Footer <span class="smalllinenumber">[line 2650]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Footer(
)</code>
</td></tr></table>
</td></tr></table><br />
This method is used to render the page footer.<br /><br /><p>It is automatically called by AddPage() and could be overwritten in your own inherited class.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodformatPageNumber"></a>
2010-03-20 13:26:55 +00:00
<h3>method formatPageNumber <span class="smalllinenumber">[line 11448]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void formatPageNumber(
int
$num)</code>
</td></tr></table>
</td></tr></table><br />
Format the page numbers.<br /><br /><p>This method can be overriden for custom formats.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.2.005 (2008-11-06)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$num</b>&nbsp;&nbsp;</td>
<td>page number</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodformatTOCPageNumber"></a>
2010-03-20 13:26:55 +00:00
<h3>method formatTOCPageNumber <span class="smalllinenumber">[line 11460]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void formatTOCPageNumber(
int
$num)</code>
</td></tr></table>
</td></tr></table><br />
Format the page numbers on the Table Of Content.<br /><br /><p>This method can be overriden for custom formats.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodaddTOC">TCPDF::addTOC()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.001 (2009-01-04)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$num</b>&nbsp;&nbsp;</td>
<td>page number</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodGetAbsX"></a>
2010-03-20 13:26:55 +00:00
<h3>method GetAbsX <span class="smalllinenumber">[line 5320]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>float GetAbsX(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the absolute X value of current position.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetX">TCPDF::SetX()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodGetY">TCPDF::GetY()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetY">TCPDF::SetY()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.2</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetAliasNbPages"></a>
2010-03-20 13:26:55 +00:00
<h3>method getAliasNbPages <span class="smalllinenumber">[line 11356]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getAliasNbPages(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the string alias used for the total number of pages.<br /><br /><p>If the current font is unicode type, the returned string is surrounded by additional curly braces.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodAliasNbPages">TCPDF::AliasNbPages()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodPageNo">TCPDF::PageNo()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodFooter">TCPDF::Footer()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.018 (2008-08-08)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetAliasNumPage"></a>
2010-03-20 13:26:55 +00:00
<h3>method getAliasNumPage <span class="smalllinenumber">[line 11384]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getAliasNumPage(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the string alias used for the page number.<br /><br /><p>If the current font is unicode type, the returned string is surrounded by additional curly braces.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodAliasNbPages">TCPDF::AliasNbPages()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodPageNo">TCPDF::PageNo()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodFooter">TCPDF::Footer()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2009-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-09-07 21:53:40 +00:00
<hr />
<a name="methodgetAnnotOptFromJSProp"></a>
2010-03-20 13:26:55 +00:00
<h3>method getAnnotOptFromJSProp <span class="smalllinenumber">[line 10287]</span></h3>
2009-09-07 21:53:40 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
2010-01-14 14:02:19 +00:00
<code>array getAnnotOptFromJSProp(
array
2009-09-07 21:53:40 +00:00
$prop)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Convert JavaScript form fields properties array to Annotation Properties array.<br /><br /><br /><br />
2009-09-07 21:53:40 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>of annotation properties</td>
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.000 (2009-09-06)</td>
</tr>
2009-09-07 21:53:40 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$prop</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>javascript field properties. Possible values are described on official Javascript for Acrobat API reference.</td>
2009-09-07 21:53:40 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="methodGetArrStringWidth"></a>
2010-03-13 19:49:15 +00:00
<h3>method GetArrStringWidth <span class="smalllinenumber">[line 3099]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
2010-01-25 17:14:23 +00:00
<code>mixed GetArrStringWidth(
2009-08-07 12:13:40 +00:00
string
2009-03-24 18:37:18 +00:00
$sa, [string
$fontname = ''], [string
$fontstyle = ''], [float
2010-01-25 17:14:23 +00:00
$fontsize = 0], [boolean
$getarray = false])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
2010-01-25 17:14:23 +00:00
Returns the string length of an array of chars in user unit or an array of characters widths. A font must be selected.<br /><br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-25 17:14:23 +00:00
<td><b>return:</b>&nbsp;&nbsp;</td><td>int total string length or array of characted widths</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.4.000 (2008-03-06)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
2009-08-07 12:13:40 +00:00
<td><b>$sa</b>&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td>The array of chars whose total length is to be computed</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$fontname</b>&nbsp;&nbsp;</td>
<td>Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$fontstyle</b>&nbsp;&nbsp;</td>
<td>Font style. Possible values are (case insensitive):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li><li>D: line trough</li></ul> or any combination. The default value is regular.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$fontsize</b>&nbsp;&nbsp;</td>
<td>Font size in points. The default value is the current size.</td>
2010-01-25 17:14:23 +00:00
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$getarray</b>&nbsp;&nbsp;</td>
<td>if true returns an array of characters widths, if false returns the total length.</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetBarcode"></a>
2010-03-20 13:26:55 +00:00
<h3>method getBarcode <span class="smalllinenumber">[line 12277]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getBarcode(
)</code>
</td></tr></table>
</td></tr></table><br />
Get current barcode.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.012 (2008-07-24)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetBorderMode"></a>
2010-03-13 19:49:15 +00:00
<h3>method getBorderMode <span class="smalllinenumber">[line 4158]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>border getBorderMode(
mixed
$border, [string
$position = 'start'])</code>
</td></tr></table>
</td></tr></table><br />
Get the border mode accounting for multicell position (opens bottom side of multicell crossing pages)<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>mode</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.4.002 (2008-12-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$border</b>&nbsp;&nbsp;</td>
<td>Indicates if borders must be drawn around the cell block. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul></td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$position</b>&nbsp;&nbsp;</td>
<td>multicell position: 'start', 'middle', 'end'</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetBreakMargin"></a>
2010-01-25 17:14:23 +00:00
<h3>method getBreakMargin <span class="smalllinenumber">[line 1982]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>int getBreakMargin(
[int
$pagenum = ''])</code>
</td></tr></table>
</td></tr></table><br />
Returns the page break margin.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>page break margin.</td>
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetPageDimensions">TCPDF::getPageDimensions()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.5.2</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$pagenum</b>&nbsp;&nbsp;</td>
<td>page number (empty = current page)</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetBuffer"></a>
2010-03-20 13:26:55 +00:00
<h3>method getBuffer <span class="smalllinenumber">[line 15870]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getBuffer(
)</code>
</td></tr></table>
</td></tr></table><br />
Get buffer content.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>buffer content</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2009-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetCellCode"></a>
2010-03-13 19:49:15 +00:00
<h3>method getCellCode <span class="smalllinenumber">[line 3757]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void getCellCode(
float
$w, [float
$h = 0], [string
$txt = ''], [mixed
$border = 0], [int
$ln = 0], [string
$align = ''], [int
$fill = 0], [mixed
$link = ''], [int
2009-03-27 18:23:22 +00:00
$stretch = 0], [boolean
$ignore_min_height = false])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
Returns the PDF string code to print a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.<br /> If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>Cell width. If 0, the cell extends up to the right margin.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>Cell height. Default value: 0.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$txt</b>&nbsp;&nbsp;</td>
<td>String to print. Default value: empty string.</td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$border</b>&nbsp;&nbsp;</td>
<td>Indicates if borders must be drawn around the cell. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul></td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$ln</b>&nbsp;&nbsp;</td>
<td>Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL languages)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul>Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$align</b>&nbsp;&nbsp;</td>
<td>Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul></td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$fill</b>&nbsp;&nbsp;</td>
<td>Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.</td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$link</b>&nbsp;&nbsp;</td>
<td>URL or identifier returned by AddLink().</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$stretch</b>&nbsp;&nbsp;</td>
<td>stretch carachter mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if necessary</li><li>4 = forced character spacing</li></ul></td>
2009-03-27 18:23:22 +00:00
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$ignore_min_height</b>&nbsp;&nbsp;</td>
<td>if true ignore automatic minimum height value.</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetCellHeightRatio"></a>
2010-03-20 13:26:55 +00:00
<h3>method getCellHeightRatio <span class="smalllinenumber">[line 11632]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void getCellHeightRatio(
)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
return the height of cell repect font height.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.012 (2008-07-24)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodGetCharWidth"></a>
2010-03-13 19:49:15 +00:00
<h3>method GetCharWidth <span class="smalllinenumber">[line 3135]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>int GetCharWidth(
int
$char)</code>
</td></tr></table>
</td></tr></table><br />
2009-09-12 09:43:42 +00:00
Returns the length of the char in user unit for the current font.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>char width</td>
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.4.000 (2008-03-06)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$char</b>&nbsp;&nbsp;</td>
<td>The char code whose length is to be returned</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetFontBuffer"></a>
2010-03-20 13:26:55 +00:00
<h3>method getFontBuffer <span class="smalllinenumber">[line 16030]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getFontBuffer(
string
$font)</code>
</td></tr></table>
</td></tr></table><br />
Get font buffer content.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>font buffer content or false in case of error</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2009-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$font</b>&nbsp;&nbsp;</td>
<td>font key</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetFontFamily"></a>
2010-03-20 13:26:55 +00:00
<h3>method getFontFamily <span class="smalllinenumber">[line 12763]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getFontFamily(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the current font family name.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>current font family name</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.3.008 (2008-12-05)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetFontSize"></a>
2010-03-20 13:26:55 +00:00
<h3>method getFontSize <span class="smalllinenumber">[line 12743]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>current getFontSize(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the current font size.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>font size</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.2.000 (2008-06-23)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetFontSizePt"></a>
2010-03-20 13:26:55 +00:00
<h3>method getFontSizePt <span class="smalllinenumber">[line 12753]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>current getFontSizePt(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the current font size in points unit.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>font size in points unit</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.2.000 (2008-06-23)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetFontsList"></a>
2010-03-13 19:49:15 +00:00
<h3>method getFontsList <span class="smalllinenumber">[line 3174]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void getFontsList(
)</code>
</td></tr></table>
</td></tr></table><br />
Fill the list of available fonts ($this-&gt;fontlist).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.013 (2008-07-28)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetFontStyle"></a>
2010-03-20 13:26:55 +00:00
<h3>method getFontStyle <span class="smalllinenumber">[line 12773]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getFontStyle(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the current font style.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>current font style</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.3.008 (2008-12-05)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetFooterFont"></a>
2010-03-20 13:26:55 +00:00
<h3>method getFooterFont <span class="smalllinenumber">[line 7863]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array() getFooterFont(
)</code>
</td></tr></table>
</td></tr></table><br />
Get Footer font.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.012 (2008-07-24)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetFooterMargin"></a>
2010-03-13 19:49:15 +00:00
<h3>method getFooterMargin <span class="smalllinenumber">[line 2564]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>float getFooterMargin(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns footer margin in user units.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.012 (2008-07-24)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
2009-09-07 21:53:40 +00:00
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetFormDefaultProp"></a>
2010-03-20 13:26:55 +00:00
<h3>method getFormDefaultProp <span class="smalllinenumber">[line 10662]</span></h3>
2009-09-07 21:53:40 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
2010-01-14 14:02:19 +00:00
<code>array getFormDefaultProp(
2009-09-07 21:53:40 +00:00
)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Return the default properties for form fields.<br /><br /><br /><br />
2009-09-07 21:53:40 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>javascript field properties. Possible values are described on official Javascript for Acrobat API reference.</td>
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.000 (2009-09-06)</td>
</tr>
2009-09-07 21:53:40 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
2009-03-24 18:37:18 +00:00
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetGDgamma"></a>
2010-03-20 13:26:55 +00:00
<h3>method getGDgamma <span class="smalllinenumber">[line 5263]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void getGDgamma(
float
$v)</code>
</td></tr></table>
</td></tr></table><br />
Correct the gamma value to be used with GD library<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.3.007 (2008-12-04)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$v</b>&nbsp;&nbsp;</td>
<td>the gamma value to be corrected</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetGraphicVars"></a>
2010-03-20 13:26:55 +00:00
<h3>method getGraphicVars <span class="smalllinenumber">[line 15738]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array getGraphicVars(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns current graphic variables as array.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>graphic variables</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.2.010 (2008-11-14)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetGroupPageNo"></a>
2010-03-20 13:26:55 +00:00
<h3>method getGroupPageNo <span class="smalllinenumber">[line 11397]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
2010-01-14 14:02:19 +00:00
<code>current getGroupPageNo(
2009-03-24 18:37:18 +00:00
)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Return the current page in the group.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>page in the group</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetGroupPageNoFormatted"></a>
2010-03-20 13:26:55 +00:00
<h3>method getGroupPageNoFormatted <span class="smalllinenumber">[line 11407]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void getGroupPageNoFormatted(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the current group page number formatted as a string.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td>PaneNo(), <a href="../com-tecnick-tcpdf/TCPDF.html#methodformatPageNumber">TCPDF::formatPageNumber()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.3.003 (2008-11-18)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetHeaderData"></a>
2010-03-13 19:49:15 +00:00
<h3>method getHeaderData <span class="smalllinenumber">[line 2519]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array() getHeaderData(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns header data:<br /><br /><p><ul><li>$ret['logo'] = logo image</li><li>$ret['logo_width'] = width of the image logo in user units</li><li>$ret['title'] = header title</li><li>$ret['string'] = header description string</li></ul></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.012 (2008-07-24)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetHeaderFont"></a>
2010-03-20 13:26:55 +00:00
<h3>method getHeaderFont <span class="smalllinenumber">[line 7843]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array() getHeaderFont(
)</code>
</td></tr></table>
</td></tr></table><br />
Get header font.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.012 (2008-07-24)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetHeaderMargin"></a>
2010-03-13 19:49:15 +00:00
<h3>method getHeaderMargin <span class="smalllinenumber">[line 2544]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>float getHeaderMargin(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns header margin in user units.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.012 (2008-07-24)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetHtmlDomArray"></a>
2010-03-20 13:26:55 +00:00
<h3>method getHtmlDomArray <span class="smalllinenumber">[line 12809]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array getHtmlDomArray(
string
$html)</code>
</td></tr></table>
</td></tr></table><br />
Returns the HTML DOM array.<br /><br /><p><ul><li>$dom[$key]['tag'] = true if tag, false otherwise;</li><li>$dom[$key]['value'] = tag name or text;</li><li>$dom[$key]['opening'] = true if opening tag, false otherwise;</li><li>$dom[$key]['attribute'] = array of attributes (attribute name is the key);</li><li>$dom[$key]['style'] = array of style attributes (attribute name is the key);</li><li>$dom[$key]['parent'] = id of parent element;</li><li>$dom[$key]['fontname'] = font family name;</li><li>$dom[$key]['fontstyle'] = font style;</li><li>$dom[$key]['fontsize'] = font size in points;</li><li>$dom[$key]['bgcolor'] = RGB array of background color;</li><li>$dom[$key]['fgcolor'] = RGB array of foreground color;</li><li>$dom[$key]['width'] = width in pixels;</li><li>$dom[$key]['height'] = height in pixels;</li><li>$dom[$key]['align'] = text alignment;</li><li>$dom[$key]['cols'] = number of colums in table;</li><li>$dom[$key]['rows'] = number of rows in table;</li></ul></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.2.000 (2008-06-20)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$html</b>&nbsp;&nbsp;</td>
<td>html code</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetHTMLUnitToUnits"></a>
2010-03-20 13:26:55 +00:00
<h3>method getHTMLUnitToUnits <span class="smalllinenumber">[line 15457]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>float getHTMLUnitToUnits(
string
$htmlval, [string
$refsize = 1], [string
$defaultunit = 'px'], [
$points = false], boolean
$point)</code>
</td></tr></table>
</td></tr></table><br />
convert html string containing value and unit of measure to user's units or points.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>value in user's unit or point if $points=true</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.4.004 (2008-12-10)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$htmlval</b>&nbsp;&nbsp;</td>
<td>string containing values and unit</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$refsize</b>&nbsp;&nbsp;</td>
<td>reference value in points</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$defaultunit</b>&nbsp;&nbsp;</td>
<td>default unit (can be one of the following: %, em, ex, px, in, mm, pc, pt).</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$point</b>&nbsp;&nbsp;</td>
<td>if true returns points, otherwise returns value in user's units</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$points</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetImageBuffer"></a>
2010-03-20 13:26:55 +00:00
<h3>method getImageBuffer <span class="smalllinenumber">[line 15972]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getImageBuffer(
string
$image)</code>
</td></tr></table>
</td></tr></table><br />
2009-09-07 21:53:40 +00:00
Get image buffer content.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>image buffer content or false in case of error</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2008-12-31)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$image</b>&nbsp;&nbsp;</td>
<td>image key</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-11-27 14:28:24 +00:00
<hr />
<a name="methodgetImageFileType"></a>
2010-03-20 13:26:55 +00:00
<h3>method getImageFileType <span class="smalllinenumber">[line 4728]</span></h3>
2009-11-27 14:28:24 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getImageFileType(
string
$imgfile)</code>
</td></tr></table>
</td></tr></table><br />
Return the image type given the file name and path<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>image type</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.017 (2009-11-27)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$imgfile</b>&nbsp;&nbsp;</td>
<td>image file name</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="methodgetImageRBX"></a>
2010-03-13 19:49:15 +00:00
<h3>method getImageRBX <span class="smalllinenumber">[line 2590]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>float getImageRBX(
)</code>
</td></tr></table>
</td></tr></table><br />
Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetImageRBY"></a>
2010-03-13 19:49:15 +00:00
<h3>method getImageRBY <span class="smalllinenumber">[line 2599]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>float getImageRBY(
)</code>
</td></tr></table>
</td></tr></table><br />
Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetImageScale"></a>
2010-01-25 17:14:23 +00:00
<h3>method getImageScale <span class="smalllinenumber">[line 1921]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>float getImageScale(
)</code>
</td></tr></table>
</td></tr></table><br />
2009-04-20 16:18:44 +00:00
Returns the adjusting factor to convert pixels to user units.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2009-04-20 16:18:44 +00:00
<td><b>return:</b>&nbsp;&nbsp;</td><td>adjusting factor to convert pixels to user units.</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.5.2</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetLastH"></a>
2010-01-25 17:14:23 +00:00
<h3>method getLastH <span class="smalllinenumber">[line 1899]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>last getLastH(
)</code>
</td></tr></table>
</td></tr></table><br />
Get the last cell height.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>cell height</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.017 (2008-08-05)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodGetLineWidth"></a>
2010-03-20 13:26:55 +00:00
<h3>method GetLineWidth <span class="smalllinenumber">[line 8521]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>int GetLineWidth(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the current the line width.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>Line width</td>
</tr>
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodLine">TCPDF::Line()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineWidth">TCPDF::SetLineWidth()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetMargins"></a>
2010-03-20 13:26:55 +00:00
<h3>method getMargins <span class="smalllinenumber">[line 12706]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array getMargins(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns an array containing current margins:<br /><br /><p><ul></ul></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>containing all margins measures</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.2.000 (2008-06-23)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodGetNumChars"></a>
2010-03-13 19:49:15 +00:00
<h3>method GetNumChars <span class="smalllinenumber">[line 3162]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>int GetNumChars(
string
$s)</code>
</td></tr></table>
</td></tr></table><br />
Returns the numbero of characters in a string.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>number of characters</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.0001 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$s</b>&nbsp;&nbsp;</td>
<td>The input string.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetNumLines"></a>
2010-03-20 13:26:55 +00:00
<h3>method getNumLines <span class="smalllinenumber">[line 4246]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>int getNumLines(
string
$txt, [float
$w = 0])</code>
</td></tr></table>
</td></tr></table><br />
2010-03-20 13:26:55 +00:00
This method returns the estimated number of lines required to print the text (not the real number just a quick estimation).<br /><br /><p>If you want o know the exact number of lines you have to use the following technique: <pre> // store current object
$pdf->startTransaction();
// get the number of lines for multicell
$lines = $pdf->MultiCell($w, 0, $txt, 0, 'L', 0, 0, '', '', true, 0, false, true, 0);
// restore previous object
$pdf = $pdf->rollbackTransaction();</pre></p><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>Return the estimated number of lines.</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.011</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$txt</b>&nbsp;&nbsp;</td>
<td>text to print</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>width of cell. If 0, they extend up to the right margin of the page.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetNumPages"></a>
2010-03-13 19:49:15 +00:00
<h3>method getNumPages <span class="smalllinenumber">[line 2378]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>int getNumPages(
)</code>
</td></tr></table>
</td></tr></table><br />
Get the total number of insered pages.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>number of pages</td>
</tr>
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetPage">TCPDF::setPage()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodgetPage">TCPDF::getPage()</a>, lastpage()</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetObjFilename"></a>
2010-03-20 13:26:55 +00:00
<h3>method getObjFilename <span class="smalllinenumber">[line 15802]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void getObjFilename(
$name, string
$prefix)</code>
</td></tr></table>
</td></tr></table><br />
Returns a temporary filename for caching object on filesystem.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2008-12-31)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$prefix</b>&nbsp;&nbsp;</td>
<td>prefix to add to filename return string filename.</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$name</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetOriginalMargins"></a>
2010-03-20 13:26:55 +00:00
<h3>method getOriginalMargins <span class="smalllinenumber">[line 12729]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array getOriginalMargins(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns an array containing original margins:<br /><br /><p><ul></ul></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>containing all margins measures</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.012 (2008-07-24)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetPage"></a>
2010-03-13 19:49:15 +00:00
<h3>method getPage <span class="smalllinenumber">[line 2366]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>int getPage(
)</code>
</td></tr></table>
</td></tr></table><br />
Get current document page number.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>page number</td>
</tr>
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetPage">TCPDF::setPage()</a>, lastpage(), <a href="../com-tecnick-tcpdf/TCPDF.html#methodgetNumPages">TCPDF::getNumPages()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetPageBuffer"></a>
2010-03-20 13:26:55 +00:00
<h3>method getPageBuffer <span class="smalllinenumber">[line 15913]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getPageBuffer(
int
$page)</code>
</td></tr></table>
</td></tr></table><br />
Get page buffer content.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>page buffer content or false in case of error</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2008-12-31)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$page</b>&nbsp;&nbsp;</td>
<td>page number</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetPageDimensions"></a>
2010-01-25 17:14:23 +00:00
<h3>method getPageDimensions <span class="smalllinenumber">[line 1934]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array getPageDimensions(
[int
$pagenum = ''])</code>
</td></tr></table>
</td></tr></table><br />
Returns an array of page dimensions:<br /><br /><p><ul><li>$this-&gt;pagedim[$this-&gt;page]['w'] =&gt; page_width_in_points</li><li>$this-&gt;pagedim[$this-&gt;page]['h'] =&gt; height in points</li><li>$this-&gt;pagedim[$this-&gt;page]['wk'] =&gt; page_width_in_points</li><li>$this-&gt;pagedim[$this-&gt;page]['hk'] =&gt; height</li><li>$this-&gt;pagedim[$this-&gt;page]['tm'] =&gt; top_margin</li><li>$this-&gt;pagedim[$this-&gt;page]['bm'] =&gt; bottom_margin</li><li>$this-&gt;pagedim[$this-&gt;page]['lm'] =&gt; left_margin</li><li>$this-&gt;pagedim[$this-&gt;page]['rm'] =&gt; right_margin</li><li>$this-&gt;pagedim[$this-&gt;page]['pb'] =&gt; auto_page_break</li><li>$this-&gt;pagedim[$this-&gt;page]['or'] =&gt; page_orientation</li><li>$this-&gt;pagedim[$this-&gt;page]['olm'] =&gt; original_left_margin</li><li>$this-&gt;pagedim[$this-&gt;page]['orm'] =&gt; original_right_margin</li></ul></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>of page dimensions.</td>
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.027 (2009-03-16)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$pagenum</b>&nbsp;&nbsp;</td>
<td>page number (empty = current page)</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetPageGroupAlias"></a>
2010-03-20 13:26:55 +00:00
<h3>method getPageGroupAlias <span class="smalllinenumber">[line 11419]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
2010-01-14 14:02:19 +00:00
<code>alias getPageGroupAlias(
2009-03-24 18:37:18 +00:00
)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Return the alias of the current page group If the current font is unicode type, the returned string is surrounded by additional curly braces.<br /><br /><p>(will be replaced by the total number of pages in this group).</p><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>of the current page group</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetPageHeight"></a>
2010-01-25 17:14:23 +00:00
<h3>method getPageHeight <span class="smalllinenumber">[line 1966]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>int getPageHeight(
[int
$pagenum = ''])</code>
</td></tr></table>
</td></tr></table><br />
Returns the page height in units.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>page height.</td>
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetPageDimensions">TCPDF::getPageDimensions()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.5.2</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$pagenum</b>&nbsp;&nbsp;</td>
<td>page number (empty = current page)</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetPageNumGroupAlias"></a>
2010-03-20 13:26:55 +00:00
<h3>method getPageNumGroupAlias <span class="smalllinenumber">[line 11434]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
2010-01-14 14:02:19 +00:00
<code>alias getPageNumGroupAlias(
2009-03-24 18:37:18 +00:00
)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Return the alias for the page number on the current page group If the current font is unicode type, the returned string is surrounded by additional curly braces.<br /><br /><p>(will be replaced by the total number of pages in this group).</p><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>of the current page group</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2009-01-02)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetPageWidth"></a>
2010-01-25 17:14:23 +00:00
<h3>method getPageWidth <span class="smalllinenumber">[line 1950]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>int getPageWidth(
[int
$pagenum = ''])</code>
</td></tr></table>
</td></tr></table><br />
Returns the page width in units.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>page width.</td>
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetPageDimensions">TCPDF::getPageDimensions()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.5.2</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$pagenum</b>&nbsp;&nbsp;</td>
<td>page number (empty = current page)</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetPDFData"></a>
2010-03-20 13:26:55 +00:00
<h3>method getPDFData <span class="smalllinenumber">[line 7886]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void getPDFData(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the PDF data.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetRemainingWidth"></a>
2010-03-20 13:26:55 +00:00
<h3>method getRemainingWidth <span class="smalllinenumber">[line 4630]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>int getRemainingWidth(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the remaining width between the current position and margins.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>Return the remaining width</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetRTL"></a>
2010-01-25 17:14:23 +00:00
<h3>method getRTL <span class="smalllinenumber">[line 1834]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean getRTL(
)</code>
</td></tr></table>
</td></tr></table><br />
Return the RTL status<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.012 (2008-07-24)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetScaleFactor"></a>
2010-01-25 17:14:23 +00:00
<h3>method getScaleFactor <span class="smalllinenumber">[line 1996]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>int getScaleFactor(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the scale factor (number of points in user unit).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>scale factor.</td>
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.5.2</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
2010-01-15 16:00:34 +00:00
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetSpaceString"></a>
2010-03-20 13:26:55 +00:00
<h3>method getSpaceString <span class="smalllinenumber">[line 13281]</span></h3>
2010-01-15 16:00:34 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getSpaceString(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the string used to find spaces<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.024 (2010-01-15)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
2009-03-24 18:37:18 +00:00
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodGetStringWidth"></a>
2010-03-13 19:49:15 +00:00
<h3>method GetStringWidth <span class="smalllinenumber">[line 3083]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
2010-01-25 17:14:23 +00:00
<code>mixed GetStringWidth(
2009-03-24 18:37:18 +00:00
string
$s, [string
$fontname = ''], [string
$fontstyle = ''], [float
2010-01-25 17:14:23 +00:00
$fontsize = 0], [boolean
$getarray = false])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
Returns the length of a string in user unit. A font must be selected.<br /><br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-25 17:14:23 +00:00
<td><b>return:</b>&nbsp;&nbsp;</td><td>int total string length or array of characted widths</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.2</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$s</b>&nbsp;&nbsp;</td>
<td>The string whose length is to be computed</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$fontname</b>&nbsp;&nbsp;</td>
<td>Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$fontstyle</b>&nbsp;&nbsp;</td>
<td>Font style. Possible values are (case insensitive):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li><li>D: line trough</li></ul> or any combination. The default value is regular.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$fontsize</b>&nbsp;&nbsp;</td>
<td>Font size in points. The default value is the current size.</td>
2010-01-25 17:14:23 +00:00
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$getarray</b>&nbsp;&nbsp;</td>
<td>if true returns an array of characters widths, if false returns the total length.</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodGetX"></a>
2010-03-20 13:26:55 +00:00
<h3>method GetX <span class="smalllinenumber">[line 5304]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>float GetX(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the relative X value of current position.<br /><br /><p>The value is relative to the left border for LTR languages and to the right border for RTL languages.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetX">TCPDF::SetX()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodGetY">TCPDF::GetY()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetY">TCPDF::SetY()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.2</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodGetY"></a>
2010-03-20 13:26:55 +00:00
<h3>method GetY <span class="smalllinenumber">[line 5331]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>float GetY(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the ordinate of the current position.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetY">TCPDF::SetY()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodGetX">TCPDF::GetX()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetX">TCPDF::SetX()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
2009-08-17 16:00:15 +00:00
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodget_mqr"></a>
2010-03-20 13:26:55 +00:00
<h3>method get_mqr <span class="smalllinenumber">[line 5023]</span></h3>
2009-08-17 16:00:15 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>Returns get_mqr(
)</code>
</td></tr></table>
</td></tr></table><br />
Gets the current active configuration setting of magic_quotes_runtime (if the get_magic_quotes_runtime function exist)<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>0 if magic quotes runtime is off or get_magic_quotes_runtime doesn't exist, 1 otherwise.</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.6.025 (2009-08-17)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
2009-03-24 18:37:18 +00:00
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodGradient"></a>
2010-03-20 13:26:55 +00:00
<h3>method Gradient <span class="smalllinenumber">[line 11815]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Gradient(
int
$type, array
$col1, array
$col2, array
$coords)</code>
</td></tr></table>
</td></tr></table><br />
Output gradient.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Andreas W<>rmser, Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-06-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$type</b>&nbsp;&nbsp;</td>
<td>type of gradient.</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$col1</b>&nbsp;&nbsp;</td>
<td>first color (RGB components).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$col2</b>&nbsp;&nbsp;</td>
<td>second color (RGB components).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$coords</b>&nbsp;&nbsp;</td>
<td>array of coordinates.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodHeader"></a>
2010-03-13 19:49:15 +00:00
<h3>method Header <span class="smalllinenumber">[line 2608]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Header(
)</code>
</td></tr></table>
</td></tr></table><br />
This method is used to render the page header.<br /><br /><p>It is automatically called by AddPage() and could be overwritten in your own inherited class.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodImage"></a>
2010-03-20 13:26:55 +00:00
<h3>method Image <span class="smalllinenumber">[line 4771]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>image Image(
string
$file, [float
$x = ''], [float
$y = ''], [float
$w = 0], [float
$h = 0], [string
$type = ''], [mixed
$link = ''], [string
2009-12-16 20:18:04 +00:00
$align = ''], [mixed
2009-03-24 18:37:18 +00:00
$resize = false], [int
$dpi = 300], [string
$palign = ''], [boolean
$ismask = false], [mixed
$imgmask = false], [mixed
2009-05-18 18:13:19 +00:00
$border = 0], [boolean
2009-09-07 21:53:40 +00:00
$fitbox = false], [boolean
$hidden = false])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
Puts an image in the page.<br /><br /><p>The upper-left corner must be given. The dimensions can be specified in different ways:<ul><li>explicit width and height (expressed in user unit)</li><li>one explicit dimension, the other being calculated automatically in order to keep the original proportions</li><li>no explicit dimension, in which case the image is put at 72 dpi</li></ul> Supported formats are JPEG and PNG images whitout GD library and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM; The format can be specified explicitly or inferred from the file extension.<br /> It is possible to put a link on the image.<br /> Remark: if an image is used several times, only one copy will be embedded in the file.<br /></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>information</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$file</b>&nbsp;&nbsp;</td>
<td>Name of the file containing the image.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>Abscissa of the upper-left corner.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>Ordinate of the upper-left corner.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>Width of the image in the page. If not specified or equal to zero, it is automatically calculated.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>Height of the image in the page. If not specified or equal to zero, it is automatically calculated.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$type</b>&nbsp;&nbsp;</td>
<td>Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.</td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$link</b>&nbsp;&nbsp;</td>
<td>URL or identifier returned by AddLink().</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$align</b>&nbsp;&nbsp;</td>
<td>Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul></td>
</tr>
<tr>
2009-12-16 20:18:04 +00:00
<td class="type">mixed&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$resize</b>&nbsp;&nbsp;</td>
2009-12-16 20:18:04 +00:00
<td>If true resize (reduce) the image to fit $w and $h (requires GD or ImageMagick library); if false do not resize; if 2 force resize in all cases (upscaling and downscaling).</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$dpi</b>&nbsp;&nbsp;</td>
<td>dot-per-inch resolution used on resize</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$palign</b>&nbsp;&nbsp;</td>
<td>Allows to center or align the image on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul></td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$ismask</b>&nbsp;&nbsp;</td>
<td>true if this image is a mask, false otherwise</td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$imgmask</b>&nbsp;&nbsp;</td>
<td>image object returned by this function or false</td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$border</b>&nbsp;&nbsp;</td>
<td>Indicates if borders must be drawn around the image. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul></td>
2009-05-18 18:13:19 +00:00
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$fitbox</b>&nbsp;&nbsp;</td>
<td>If true scale image dimensions proportionally to fit within the ($w, $h) box.</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$hidden</b>&nbsp;&nbsp;</td>
<td>if true do not display the image.</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodImageEps"></a>
2010-03-20 13:26:55 +00:00
<h3>method ImageEps <span class="smalllinenumber">[line 11987]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void ImageEps(
string
$file, [float
$x = ''], [float
$y = ''], [float
$w = 0], [float
$h = 0], [mixed
$link = ''], [boolean
$useBoundingBox = true], [string
$align = ''], [string
$palign = ''], [mixed
$border = 0])</code>
</td></tr></table>
</td></tr></table><br />
Embed vector-based Adobe Illustrator (AI) or AI-compatible EPS files.<br /><br /><p>Only vector drawing is supported, not text or bitmap. Although the script was successfully tested with various AI format versions, best results are probably achieved with files that were exported in the AI3 format (tested with Illustrator CS2, Freehand MX and Photoshop CS2).</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Valentin Schmidt, Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-06-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$file</b>&nbsp;&nbsp;</td>
<td>Name of the file containing the image.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>Abscissa of the upper-left corner.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>Ordinate of the upper-left corner.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>Width of the image in the page. If not specified or equal to zero, it is automatically calculated.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>Height of the image in the page. If not specified or equal to zero, it is automatically calculated.</td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$link</b>&nbsp;&nbsp;</td>
<td>URL or identifier returned by AddLink().</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$align</b>&nbsp;&nbsp;</td>
<td>Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul></td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$palign</b>&nbsp;&nbsp;</td>
<td>Allows to center or align the image on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul></td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$border</b>&nbsp;&nbsp;</td>
<td>Indicates if borders must be drawn around the image. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul></td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$useBoundingBox</b>&nbsp;&nbsp;</td>
<td>useBoundingBox specifies whether to position the bounding box (true) or the complete canvas (false) at location (x,y). Default value is true.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodImagePngAlpha"></a>
2010-03-20 13:26:55 +00:00
<h3>method ImagePngAlpha <span class="smalllinenumber">[line 5219]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void ImagePngAlpha(
string
$file, [float
$x = ''], [float
$y = ''], [float
$w = 0], [float
$h = 0], [string
$type = ''], [mixed
$link = ''], [string
$align = ''], [boolean
$resize = false], [int
$dpi = 300], [string
$palign = ''])</code>
</td></tr></table>
</td></tr></table><br />
Extract info from a PNG image with alpha channel using the GD library.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Valentin Schmidt, Nicola Asuni</td>
</tr>
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodImage">TCPDF::Image()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.3.007 (2008-12-04)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$file</b>&nbsp;&nbsp;</td>
<td>Name of the file containing the image.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>Abscissa of the upper-left corner.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>Ordinate of the upper-left corner.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>Width of the image in the page. If not specified or equal to zero, it is automatically calculated.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>Height of the image in the page. If not specified or equal to zero, it is automatically calculated.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$type</b>&nbsp;&nbsp;</td>
<td>Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.</td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$link</b>&nbsp;&nbsp;</td>
<td>URL or identifier returned by AddLink().</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$align</b>&nbsp;&nbsp;</td>
<td>Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul></td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$resize</b>&nbsp;&nbsp;</td>
<td>If true resize (reduce) the image to fit $w and $h (requires GD library).</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$dpi</b>&nbsp;&nbsp;</td>
<td>dot-per-inch resolution used on resize</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$palign</b>&nbsp;&nbsp;</td>
<td>Allows to center or align the image on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodIncludeJS"></a>
2010-03-20 13:26:55 +00:00
<h3>method IncludeJS <span class="smalllinenumber">[line 10143]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void IncludeJS(
2010-01-14 14:02:19 +00:00
string
2009-03-24 18:37:18 +00:00
$script)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Adds a javascript<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Johannes G<>ntert, Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.002 (2008-02-12)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$script</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Javascript code</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodintToRoman"></a>
2010-03-20 13:26:55 +00:00
<h3>method intToRoman <span class="smalllinenumber">[line 15531]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string intToRoman(
int
$number)</code>
</td></tr></table>
</td></tr></table><br />
Returns the Roman representation of an integer number<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>roman representation of the specified number</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.4.004 (2008-12-10)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$number</b>&nbsp;&nbsp;</td>
<td>number to convert</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-11-04 08:57:52 +00:00
<hr />
<a name="methodisRTLTextDir"></a>
2010-01-25 17:14:23 +00:00
<h3>method isRTLTextDir <span class="smalllinenumber">[line 1878]</span></h3>
2009-11-04 08:57:52 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean isRTLTextDir(
)</code>
</td></tr></table>
</td></tr></table><br />
Return the current temporary RTL status<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.014 (2009-11-04)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="methodlastPage"></a>
2010-03-13 19:49:15 +00:00
<h3>method lastPage <span class="smalllinenumber">[line 2355]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void lastPage(
[boolean
$resetmargins = false])</code>
</td></tr></table>
</td></tr></table><br />
Reset pointer to the last document page.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetPage">TCPDF::setPage()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodgetPage">TCPDF::getPage()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodgetNumPages">TCPDF::getNumPages()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000 (2008-01-04)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$resetmargins</b>&nbsp;&nbsp;</td>
<td>if true reset left, right, top margins and Y position.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodLine"></a>
2010-03-20 13:26:55 +00:00
<h3>method Line <span class="smalllinenumber">[line 8674]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Line(
float
$x1, float
$y1, float
$x2, float
$y2, [array
$style = array()])</code>
</td></tr></table>
</td></tr></table><br />
Draws a line between two points.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineWidth">TCPDF::SetLineWidth()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetDrawColor">TCPDF::SetDrawColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">TCPDF::SetLineStyle()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x1</b>&nbsp;&nbsp;</td>
<td>Abscissa of first point.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y1</b>&nbsp;&nbsp;</td>
<td>Ordinate of first point.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x2</b>&nbsp;&nbsp;</td>
<td>Abscissa of second point.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y2</b>&nbsp;&nbsp;</td>
<td>Ordinate of second point.</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>Line style. Array like for <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">SetLineStyle</a>. Default value: default line style (empty array).</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodLinearGradient"></a>
2010-03-20 13:26:55 +00:00
<h3>method LinearGradient <span class="smalllinenumber">[line 11672]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void LinearGradient(
float
$x, float
$y, float
$w, float
$h, [array
$col1 = array()], [array
$col2 = array()], [array
$coords = array(0,0,1,0)])</code>
</td></tr></table>
</td></tr></table><br />
Paints a linear colour gradient.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Andreas W<>rmser, Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-06-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>abscissa of the top left corner of the rectangle.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>ordinate of the top left corner of the rectangle.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>width of the rectangle.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>height of the rectangle.</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$col1</b>&nbsp;&nbsp;</td>
<td>first color (RGB components).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$col2</b>&nbsp;&nbsp;</td>
<td>second color (RGB components).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$coords</b>&nbsp;&nbsp;</td>
<td>array of the form (x1, y1, x2, y2) which defines the gradient vector (see linear_gradient_coords.jpg). The default value is from left to right (x1=0, y1=0, x2=1, y2=0).</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodLink"></a>
2010-03-13 19:49:15 +00:00
<h3>method Link <span class="smalllinenumber">[line 3476]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Link(
float
$x, float
$y, float
$w, float
$h, mixed
$link, [int
$spaces = 0])</code>
</td></tr></table>
</td></tr></table><br />
Puts a link on a rectangular area of the page.<br /><br /><p>Text or image links are generally put via Cell(), Write() or Image(), but this method can be useful for instance to define a clickable area inside an image.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodAddLink">TCPDF::AddLink()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodAnnotation">TCPDF::Annotation()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodWrite">TCPDF::Write()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodImage">TCPDF::Image()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.5</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>Abscissa of the upper-left corner of the rectangle</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>Ordinate of the upper-left corner of the rectangle</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>Width of the rectangle</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>Height of the rectangle</td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$link</b>&nbsp;&nbsp;</td>
<td>URL or identifier returned by AddLink()</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$spaces</b>&nbsp;&nbsp;</td>
<td>number of spaces on the text to link</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodListBox"></a>
2010-03-20 13:26:55 +00:00
<h3>method ListBox <span class="smalllinenumber">[line 10859]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void ListBox(
2010-01-14 14:02:19 +00:00
string
$name, int
$w, int
$h, array
$values, [array
$prop = array()], [array
$opt = array()], [float
$x = ''], [float
$y = ''], [boolean
2009-09-07 21:53:40 +00:00
$js = false])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Creates a List-box field<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.000 (2009-09-07)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$name</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>field name</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$w</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>width</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$h</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>height</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$values</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>array containing the list of values.</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$prop</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>javascript field properties. Possible values are described on official Javascript for Acrobat API reference.</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$opt</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>annotation parameters. Possible values are described on official PDF32000_2008 reference.</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$x</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Abscissa of the upper-left corner of the rectangle</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$y</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Ordinate of the upper-left corner of the rectangle</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">boolean&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$js</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>if true put the field using JavaScript (requires Acrobat Writer to be rendered).</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodLn"></a>
2010-03-20 13:26:55 +00:00
<h3>method Ln <span class="smalllinenumber">[line 5276]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Ln(
[float
$h = ''], [boolean
$cell = false])</code>
</td></tr></table>
</td></tr></table><br />
Performs a line break.<br /><br /><p>The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>The height of the break. By default, the value equals the height of the last printed cell.</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$cell</b>&nbsp;&nbsp;</td>
<td>if true add a cMargin to the x coordinate</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodMirrorH"></a>
2010-03-20 13:26:55 +00:00
<h3>method MirrorH <span class="smalllinenumber">[line 8293]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void MirrorH(
[int
$x = ''])</code>
</td></tr></table>
</td></tr></table><br />
Horizontal Mirroring.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">TCPDF::StartTransform()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">TCPDF::StopTransform()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>abscissa of the point. Default is current x position</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodMirrorL"></a>
2010-03-20 13:26:55 +00:00
<h3>method MirrorL <span class="smalllinenumber">[line 8329]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void MirrorL(
[float
$angle = 0], [int
$x = ''], [int
$y = ''])</code>
</td></tr></table>
</td></tr></table><br />
Reflection against a straight line through point (x, y) with the gradient angle (angle).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">TCPDF::StartTransform()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">TCPDF::StopTransform()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$angle</b>&nbsp;&nbsp;</td>
<td>gradient angle of the straight line. Default is 0 (horizontal line).</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>abscissa of the point. Default is current x position</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>ordinate of the point. Default is current y position</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodMirrorP"></a>
2010-03-20 13:26:55 +00:00
<h3>method MirrorP <span class="smalllinenumber">[line 8316]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void MirrorP(
[int
$x = ''], [int
$y = ''])</code>
</td></tr></table>
</td></tr></table><br />
Point reflection mirroring.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">TCPDF::StartTransform()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">TCPDF::StopTransform()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>abscissa of the point. Default is current x position</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>ordinate of the point. Default is current y position</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodMirrorV"></a>
2010-03-20 13:26:55 +00:00
<h3>method MirrorV <span class="smalllinenumber">[line 8304]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void MirrorV(
[int
$y = ''])</code>
</td></tr></table>
</td></tr></table><br />
Verical Mirroring.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">TCPDF::StartTransform()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">TCPDF::StopTransform()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>ordinate of the point. Default is current y position</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodmovePage"></a>
2010-03-20 13:26:55 +00:00
<h3>method movePage <span class="smalllinenumber">[line 16047]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>true movePage(
int
$frompage, int
$topage)</code>
</td></tr></table>
</td></tr></table><br />
2009-04-23 08:53:25 +00:00
Move a page to a previous position.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>in case of success, false in case of error.</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2009-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$frompage</b>&nbsp;&nbsp;</td>
<td>number of the source page</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$topage</b>&nbsp;&nbsp;</td>
<td>number of the destination page (must be less than $frompage)</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodMultiCell"></a>
2010-03-13 19:49:15 +00:00
<h3>method MultiCell <span class="smalllinenumber">[line 3999]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>int MultiCell(
float
$w, float
$h, string
$txt, [mixed
$border = 0], [string
$align = 'J'], [int
$fill = 0], [int
2009-07-05 20:00:18 +00:00
$ln = 1], [float
$x = ''], [float
2009-03-24 18:37:18 +00:00
$y = ''], [boolean
$reseth = true], [int
$stretch = 0], [boolean
$ishtml = false], [boolean
$autopadding = true], [float
$maxh = 0])</code>
</td></tr></table>
</td></tr></table><br />
This method allows printing text with line breaks.<br /><br /><p>They can be automatic (as soon as the text reaches the right border of the cell) or explicit (via the \n character). As many cells as necessary are output, one below the other.<br /> Text can be aligned, centered or justified. The cell block can be framed and the background painted.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>Return the number of cells or 1 for html mode.</td>
</tr>
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFont">TCPDF::SetFont()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetDrawColor">TCPDF::SetDrawColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFillColor">TCPDF::SetFillColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTextColor">TCPDF::SetTextColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineWidth">TCPDF::SetLineWidth()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodWrite">TCPDF::Write()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetAutoPageBreak">TCPDF::SetAutoPageBreak()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.3</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
<tr>
<td><b>usedby:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodwriteHTMLCell">TCPDF::writeHTMLCell()</a></td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>Width of cells. If 0, they extend up to the right margin of the page.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>Cell minimum height. The cell extends automatically if needed.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$txt</b>&nbsp;&nbsp;</td>
<td>String to print</td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$border</b>&nbsp;&nbsp;</td>
<td>Indicates if borders must be drawn around the cell block. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul></td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$align</b>&nbsp;&nbsp;</td>
<td>Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align</li><li>C: center</li><li>R: right align</li><li>J: justification (default value when $ishtml=false)</li></ul></td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$fill</b>&nbsp;&nbsp;</td>
<td>Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$ln</b>&nbsp;&nbsp;</td>
<td>Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul></td>
</tr>
<tr>
2009-07-05 20:00:18 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>x position in user units</td>
</tr>
<tr>
2009-07-05 20:00:18 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>y position in user units</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$reseth</b>&nbsp;&nbsp;</td>
<td>if true reset the last cell height (default true).</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$stretch</b>&nbsp;&nbsp;</td>
<td>stretch carachter mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if necessary</li><li>4 = forced character spacing</li></ul></td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$ishtml</b>&nbsp;&nbsp;</td>
<td>set to true if $txt is HTML content (default = false).</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$autopadding</b>&nbsp;&nbsp;</td>
<td>if true, uses internal padding and automatically adjust it to account for line width.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$maxh</b>&nbsp;&nbsp;</td>
<td>maximum height. It should be &gt;= $h and less then remaining space to the bottom of the page, or 0 for disable this feature. This feature works only when $ishtml=false.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodobjclone"></a>
2010-03-20 13:26:55 +00:00
<h3>method objclone <span class="smalllinenumber">[line 16527]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>cloned objclone(
object
$object)</code>
</td></tr></table>
</td></tr></table><br />
Creates a copy of a class object<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>object</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.029 (2009-03-19)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">object&nbsp;&nbsp;</td>
<td><b>$object</b>&nbsp;&nbsp;</td>
<td>class object to be cloned</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodOpen"></a>
2010-03-13 19:49:15 +00:00
<h3>method Open <span class="smalllinenumber">[line 2272]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Open(
)</code>
</td></tr></table>
</td></tr></table><br />
This method begins the generation of the PDF document.<br /><br /><p>It is not necessary to call it explicitly because AddPage() does it automatically. Note: no page is created by this method</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodAddPage">TCPDF::AddPage()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodClose">TCPDF::Close()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodopenHTMLTagHandler"></a>
2010-03-20 13:26:55 +00:00
<h3>method openHTMLTagHandler <span class="smalllinenumber">[line 14395]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void openHTMLTagHandler(
&$dom, int
$key, [boolean
$cell = false], array
$dom)</code>
</td></tr></table>
</td></tr></table><br />
Process opening tags.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$dom</b>&nbsp;&nbsp;</td>
<td>html dom array</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$key</b>&nbsp;&nbsp;</td>
<td>current element id</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$cell</b>&nbsp;&nbsp;</td>
<td>if true add the default cMargin space to each new line (default false).</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>&$dom</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodOutput"></a>
2010-03-20 13:26:55 +00:00
<h3>method Output <span class="smalllinenumber">[line 5423]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Output(
[string
$name = 'doc.pdf'], [string
$dest = 'I'])</code>
</td></tr></table>
</td></tr></table><br />
Send the document to a given destination: string, local file or browser.<br /><br /><p>In the last case, the plug-in may be used (if present) or a download (&quot;Save as&quot; dialog box) may be forced.<br /> The method first calls Close() if necessary to terminate the document.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodClose">TCPDF::Close()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$name</b>&nbsp;&nbsp;</td>
<td>The name of the file when saved. Note that special characters are removed and blanks characters are replaced with the underscore character.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$dest</b>&nbsp;&nbsp;</td>
<td>Destination where to send the document. It can take one of the following values:<ul><li>I: send the file inline to the browser (default). The plug-in is used if available. The name given by name is used when one selects the &quot;Save as&quot; option on the link generating the PDF.</li><li>D: send to the browser and force a file download with the name given by name.</li><li>F: save to a local file with the name given by name.</li><li>S: return the document as a string. name is ignored.</li></ul></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodPageNo"></a>
2010-03-13 19:49:15 +00:00
<h3>method PageNo <span class="smalllinenumber">[line 2802]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>int PageNo(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the current page number.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>page number</td>
</tr>
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodAliasNbPages">TCPDF::AliasNbPages()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodgetAliasNbPages">TCPDF::getAliasNbPages()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodPageNoFormatted"></a>
2010-03-20 13:26:55 +00:00
<h3>method PageNoFormatted <span class="smalllinenumber">[line 11470]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void PageNoFormatted(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the current page number formatted as a string.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td>PaneNo(), <a href="../com-tecnick-tcpdf/TCPDF.html#methodformatPageNumber">TCPDF::formatPageNumber()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.2.005 (2008-11-06)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodPieSector"></a>
2010-03-20 13:26:55 +00:00
<h3>method PieSector <span class="smalllinenumber">[line 11909]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void PieSector(
float
$xc, float
$yc, float
$r, float
$a, float
$b, [
$style = 'FD'], [
$cw = true], [
$o = 90], string
$style:, float
$cw:, float
$o:)</code>
</td></tr></table>
</td></tr></table><br />
Draw the sector of a circle.<br /><br /><p>It can be used for instance to render pie charts.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Maxime Delorme, Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-06-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$xc</b>&nbsp;&nbsp;</td>
<td>abscissa of the center.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$yc</b>&nbsp;&nbsp;</td>
<td>ordinate of the center.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$r</b>&nbsp;&nbsp;</td>
<td>radius.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$a</b>&nbsp;&nbsp;</td>
<td>start angle (in degrees).</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$b</b>&nbsp;&nbsp;</td>
<td>end angle (in degrees).</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$style:</b>&nbsp;&nbsp;</td>
<td>D, F, FD or DF (draw, fill, fill and draw). Default: FD.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$cw:</b>&nbsp;&nbsp;</td>
<td>indicates whether to go clockwise (default: true).</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$o:</b>&nbsp;&nbsp;</td>
<td>origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock). Default: 90.</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$cw</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$o</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodpixelsToUnits"></a>
2010-03-20 13:26:55 +00:00
<h3>method pixelsToUnits <span class="smalllinenumber">[line 7995]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>float pixelsToUnits(
int
$px)</code>
</td></tr></table>
</td></tr></table><br />
Converts pixels to User's Units.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>value in user's unit</td>
</tr>
2009-04-20 16:18:44 +00:00
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodsetImageScale">TCPDF::setImageScale()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodgetImageScale">TCPDF::getImageScale()</a></td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$px</b>&nbsp;&nbsp;</td>
<td>pixels</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodPolycurve"></a>
2010-03-20 13:26:55 +00:00
<h3>method Polycurve <span class="smalllinenumber">[line 8864]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Polycurve(
float
$x0, float
$y0, float
$segments, [string
$style = ''], [array
$line_style = array()], [array
$fill_color = array()])</code>
</td></tr></table>
</td></tr></table><br />
Draws a poly-Bezier curve.<br /><br /><p>Each Bezier curve segment is a tangent to the line between the control points at either end of the curve.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">TCPDF::SetLineStyle()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0008 (2008-05-12)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x0</b>&nbsp;&nbsp;</td>
<td>Abscissa of start point.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y0</b>&nbsp;&nbsp;</td>
<td>Ordinate of start point.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$segments</b>&nbsp;&nbsp;</td>
<td>An array of bezier descriptions. Format: array(x1, y1, x2, y2, x3, y3).</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>Style of rendering. Possible values are: <ul><li>D or empty string: Draw (default).</li><li>F: Fill.</li><li>DF or FD: Draw and fill.</li><li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li><li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li></ul></td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$line_style</b>&nbsp;&nbsp;</td>
<td>Line style of curve. Array like for <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">SetLineStyle</a>. Default value: default line style (empty array).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$fill_color</b>&nbsp;&nbsp;</td>
<td>Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodPolygon"></a>
2010-03-20 13:26:55 +00:00
<h3>method Polygon <span class="smalllinenumber">[line 9084]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Polygon(
array
$p, [string
$style = ''], [array
$line_style = array()], [array
2009-09-15 11:07:16 +00:00
$fill_color = array()], [boolean
$closed = true])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
Draws a polygon.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-08)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$p</b>&nbsp;&nbsp;</td>
<td>Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1))</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>Style of rendering. Possible values are: <ul><li>D or empty string: Draw (default).</li><li>F: Fill.</li><li>DF or FD: Draw and fill.</li><li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li><li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li></ul></td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$line_style</b>&nbsp;&nbsp;</td>
<td>Line style of polygon. Array with keys among the following: <ul><li>all: Line style of all lines. Array like for <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">SetLineStyle</a>.</li><li>0 to ($np - 1): Line style of each line. Array like for <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">SetLineStyle</a>.</li></ul> If a key is not present or is null, not draws the line. Default value is default line style (empty array).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$fill_color</b>&nbsp;&nbsp;</td>
<td>Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).</td>
2009-09-15 11:07:16 +00:00
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$closed</b>&nbsp;&nbsp;</td>
<td>if true the polygon is closes, otherwise will remain open</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodPolyLine"></a>
2010-03-20 13:26:55 +00:00
<h3>method PolyLine <span class="smalllinenumber">[line 9058]</span></h3>
2009-09-15 11:07:16 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void PolyLine(
array
$p, [string
$style = ''], [array
$line_style = array()], [array
$fill_color = array()], boolean
$closed)</code>
</td></tr></table>
</td></tr></table><br />
Draws a polygonal line<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.003 (2009-09-15)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$p</b>&nbsp;&nbsp;</td>
<td>Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1))</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>Style of rendering. Possible values are: <ul><li>D or empty string: Draw (default).</li><li>F: Fill.</li><li>DF or FD: Draw and fill.</li><li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li><li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li></ul></td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$line_style</b>&nbsp;&nbsp;</td>
<td>Line style of polygon. Array with keys among the following: <ul><li>all: Line style of all lines. Array like for <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">SetLineStyle</a>.</li><li>0 to ($np - 1): Line style of each line. Array like for <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">SetLineStyle</a>.</li></ul> If a key is not present or is null, not draws the line. Default value is default line style (empty array).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$fill_color</b>&nbsp;&nbsp;</td>
<td>Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$closed</b>&nbsp;&nbsp;</td>
<td>if true the polygon is closes, otherwise will remain open</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodputHtmlListBullet"></a>
2010-03-20 13:26:55 +00:00
<h3>method putHtmlListBullet <span class="smalllinenumber">[line 15596]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void putHtmlListBullet(
int
$listdepth, [string
$listtype = ''], [float
$size = 10])</code>
</td></tr></table>
</td></tr></table><br />
Output an HTML list bullet or ordered item symbol<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.4.004 (2008-12-10)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$listdepth</b>&nbsp;&nbsp;</td>
<td>list nesting level</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$listtype</b>&nbsp;&nbsp;</td>
<td>type of list</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$size</b>&nbsp;&nbsp;</td>
<td>current font size</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodRadialGradient"></a>
2010-03-20 13:26:55 +00:00
<h3>method RadialGradient <span class="smalllinenumber">[line 11690]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void RadialGradient(
float
$x, float
$y, float
$w, float
$h, [array
$col1 = array()], [array
$col2 = array()], [array
$coords = array(0.5,0.5,0.5,0.5,1)])</code>
</td></tr></table>
</td></tr></table><br />
Paints a radial colour gradient.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Andreas W<>rmser, Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-06-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>abscissa of the top left corner of the rectangle.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>ordinate of the top left corner of the rectangle.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>width of the rectangle.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>height of the rectangle.</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$col1</b>&nbsp;&nbsp;</td>
<td>first color (RGB components).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$col2</b>&nbsp;&nbsp;</td>
<td>second color (RGB components).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$coords</b>&nbsp;&nbsp;</td>
<td>array of the form (fx, fy, cx, cy, r) where (fx, fy) is the starting point of the gradient with color1, (cx, cy) is the center of the circle with color2, and r is the radius of the circle (see radial_gradient_coords.jpg). (fx, fy) should be inside the circle, otherwise some areas will not be defined.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodRadioButton"></a>
2010-03-20 13:26:55 +00:00
<h3>method RadioButton <span class="smalllinenumber">[line 10771]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void RadioButton(
2010-01-14 14:02:19 +00:00
string
$name, int
$w, [array
$prop = array()], [array
$opt = array()], [string
$onvalue = 'On'], [boolean
$checked = false], [float
$x = ''], [float
$y = ''], [boolean
2009-09-07 21:53:40 +00:00
$js = false])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Creates a RadioButton field<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.000 (2009-09-07)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$name</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>field name</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$w</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>width</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$prop</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>javascript field properties. Possible values are described on official Javascript for Acrobat API reference.</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$opt</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>annotation parameters. Possible values are described on official PDF32000_2008 reference.</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$onvalue</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>value to be returned if selected.</td>
2009-09-09 21:21:25 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">boolean&nbsp;&nbsp;</td>
2009-09-09 21:21:25 +00:00
<td><b>$checked</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>define the initial state.</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$x</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Abscissa of the upper-left corner of the rectangle</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$y</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Ordinate of the upper-left corner of the rectangle</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">boolean&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$js</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>if true put the field using JavaScript (requires Acrobat Writer to be rendered).</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodreadDiskCache"></a>
2010-03-20 13:26:55 +00:00
<h3>method readDiskCache <span class="smalllinenumber">[line 15842]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>mixed readDiskCache(
$filename, string
$file)</code>
</td></tr></table>
</td></tr></table><br />
Read data from a temporary file on filesystem.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>retrieved data</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2008-12-31)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$file</b>&nbsp;&nbsp;</td>
<td>file name</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$filename</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodRect"></a>
2010-03-20 13:26:55 +00:00
<h3>method Rect <span class="smalllinenumber">[line 8709]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Rect(
float
$x, float
$y, float
$w, float
$h, [string
$style = ''], [array
$border_style = array()], [array
$fill_color = array()])</code>
</td></tr></table>
</td></tr></table><br />
Draws a rectangle.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">TCPDF::SetLineStyle()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>Abscissa of upper-left corner (or upper-right corner for RTL language).</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>Ordinate of upper-left corner (or upper-right corner for RTL language).</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>Width.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>Height.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>Style of rendering. Possible values are: <ul><li>D or empty string: Draw (default).</li><li>F: Fill.</li><li>DF or FD: Draw and fill.</li><li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li><li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li></ul></td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$border_style</b>&nbsp;&nbsp;</td>
<td>Border style of rectangle. Array like for <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">SetLineStyle</a>. Default value: default line style (empty array).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$fill_color</b>&nbsp;&nbsp;</td>
<td>Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodRegularPolygon"></a>
2010-03-20 13:26:55 +00:00
<h3>method RegularPolygon <span class="smalllinenumber">[line 9209]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void RegularPolygon(
float
$x0, float
$y0,
$r, integer
$ns, [float
$angle = 0], [boolean
$draw_circle = false], [string
$style = ''], [array
$line_style = array()], [array
$fill_color = array()], [string
$circle_style = ''], [array
$circle_outLine_style = array()], [array
$circle_fill_color = array()], float
$r:)</code>
</td></tr></table>
</td></tr></table><br />
Draws a regular polygon.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-08)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x0</b>&nbsp;&nbsp;</td>
<td>Abscissa of center point.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y0</b>&nbsp;&nbsp;</td>
<td>Ordinate of center point.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$r:</b>&nbsp;&nbsp;</td>
<td>Radius of inscribed circle.</td>
</tr>
<tr>
<td class="type">integer&nbsp;&nbsp;</td>
<td><b>$ns</b>&nbsp;&nbsp;</td>
<td>Number of sides.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$angle</b>&nbsp;&nbsp;</td>
<td>Angle oriented (anti-clockwise). Default value: 0.</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$draw_circle</b>&nbsp;&nbsp;</td>
<td>Draw inscribed circle or not. Default value: false.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>Style of rendering. Possible values are: <ul><li>D or empty string: Draw (default).</li><li>F: Fill.</li><li>DF or FD: Draw and fill.</li><li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li><li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li></ul></td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$line_style</b>&nbsp;&nbsp;</td>
<td>Line style of polygon sides. Array with keys among the following: <ul><li>all: Line style of all sides. Array like for <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">SetLineStyle</a>.</li><li>0 to ($ns - 1): Line style of each side. Array like for <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">SetLineStyle</a>.</li></ul> If a key is not present or is null, not draws the side. Default value is default line style (empty array).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$fill_color</b>&nbsp;&nbsp;</td>
<td>Fill color. Format: array(red, green, blue). Default value: default color (empty array).</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$circle_style</b>&nbsp;&nbsp;</td>
<td>Style of rendering of inscribed circle (if draws). Possible values are: <ul><li>D or empty string: Draw (default).</li><li>F: Fill.</li><li>DF or FD: Draw and fill.</li><li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li><li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li></ul></td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$circle_outLine_style</b>&nbsp;&nbsp;</td>
<td>Line style of inscribed circle (if draws). Array like for <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">SetLineStyle</a>. Default value: default line style (empty array).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$circle_fill_color</b>&nbsp;&nbsp;</td>
<td>Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array).</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$r</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodremoveSHY"></a>
2010-03-13 19:49:15 +00:00
<h3>method removeSHY <span class="smalllinenumber">[line 3722]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string removeSHY(
[string
$txt = ''])</code>
</td></tr></table>
</td></tr></table><br />
Removes SHY characters from text.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>without SHY characters.</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>(4.5.019) 2009-02-28</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$txt</b>&nbsp;&nbsp;</td>
<td>input string</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2010-03-13 19:49:15 +00:00
<hr />
<a name="methodrevstrpos"></a>
2010-03-20 13:26:55 +00:00
<h3>method revstrpos <span class="smalllinenumber">[line 16551]</span></h3>
2010-03-13 19:49:15 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>Returns revstrpos(
string
$haystack, string
$needle, [int
$offset = 0])</code>
</td></tr></table>
</td></tr></table><br />
Find position of last occurrence of a substring in a string<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>the position where the needle exists. Returns FALSE if the needle was not found.</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.038 (2010-03-13)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$haystack</b>&nbsp;&nbsp;</td>
<td>The string to search in.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$needle</b>&nbsp;&nbsp;</td>
<td>substring to search.</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$offset</b>&nbsp;&nbsp;</td>
<td>May be specified to begin searching an arbitrary number of characters into the string.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="methodrfread"></a>
2010-03-20 13:26:55 +00:00
<h3>method rfread <span class="smalllinenumber">[line 5189]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
2009-04-16 15:53:29 +00:00
<code>Returns rfread(
2009-03-24 18:37:18 +00:00
resource
$handle, int
$length)</code>
</td></tr></table>
</td></tr></table><br />
Binary-safe and URL-safe file read.<br /><br /><p>Reads up to length bytes from the file pointer referenced by handle. Reading stops as soon as one of the following conditions is met: length bytes have been read; EOF (end of file) is reached.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2009-04-16 15:53:29 +00:00
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>the read string or FALSE in case of error.</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.027 (2009-03-16)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">resource&nbsp;&nbsp;</td>
<td><b>$handle</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$length</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodrollbackTransaction"></a>
2010-03-20 13:26:55 +00:00
<h3>method rollbackTransaction <span class="smalllinenumber">[line 16498]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
2009-04-20 16:18:44 +00:00
<code><a href="../com-tecnick-tcpdf/TCPDF.html">TCPDF</a> rollbackTransaction(
2009-09-23 17:10:28 +00:00
[boolean
$self = false])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
2009-04-20 16:18:44 +00:00
This method allows to undo the latest transaction by returning the latest saved TCPDF object with startTransaction().<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2009-04-20 16:18:44 +00:00
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>object.</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.029 (2009-03-19)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
2009-09-23 17:10:28 +00:00
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$self</b>&nbsp;&nbsp;</td>
<td>if true restores current class object to previous state without the need of reassignment via the returned value.</td>
</tr>
</table>
</div><br />
2009-03-24 18:37:18 +00:00
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodRotate"></a>
2010-03-20 13:26:55 +00:00
<h3>method Rotate <span class="smalllinenumber">[line 8388]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Rotate(
float
$angle, [int
$x = ''], [int
$y = ''])</code>
</td></tr></table>
</td></tr></table><br />
Rotate object.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">TCPDF::StartTransform()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">TCPDF::StopTransform()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$angle</b>&nbsp;&nbsp;</td>
<td>angle in degrees for counter-clockwise rotation</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>abscissa of the rotation center. Default is current x position</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>ordinate of the rotation center. Default is current y position</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodRoundedRect"></a>
2010-03-20 13:26:55 +00:00
<h3>method RoundedRect <span class="smalllinenumber">[line 9313]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void RoundedRect(
float
$x, float
$y, float
$w, float
$h, float
$r, [string
$round_corner = '1111'], [string
$style = ''], [array
$border_style = array()], [array
$fill_color = array()])</code>
</td></tr></table>
</td></tr></table><br />
Draws a rounded rectangle.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-08)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>Abscissa of upper-left corner.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>Ordinate of upper-left corner.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>Width.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>Height.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$r</b>&nbsp;&nbsp;</td>
<td>Radius of the rounded corners.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$round_corner</b>&nbsp;&nbsp;</td>
<td>Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top left, top right, bottom right and bottom left. Default value: all rounded corner (&quot;1111&quot;).</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>Style of rendering. Possible values are: <ul><li>D or empty string: Draw (default).</li><li>F: Fill.</li><li>DF or FD: Draw and fill.</li><li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li><li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li></ul></td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$border_style</b>&nbsp;&nbsp;</td>
<td>Border style of rectangle. Array like for <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">SetLineStyle</a>. Default value: default line style (empty array).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$fill_color</b>&nbsp;&nbsp;</td>
<td>Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodScale"></a>
2010-03-20 13:26:55 +00:00
<h3>method Scale <span class="smalllinenumber">[line 8258]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Scale(
float
$s_x, float
$s_y, [int
$x = ''], [int
$y = ''])</code>
</td></tr></table>
</td></tr></table><br />
Vertical and horizontal non-proportional Scaling.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">TCPDF::StartTransform()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">TCPDF::StopTransform()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$s_x</b>&nbsp;&nbsp;</td>
<td>scaling factor for width as percent. 0 is not allowed.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$s_y</b>&nbsp;&nbsp;</td>
<td>scaling factor for height as percent. 0 is not allowed.</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>abscissa of the scaling center. Default is current x position</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>ordinate of the scaling center. Default is current y position</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodScaleX"></a>
2010-03-20 13:26:55 +00:00
<h3>method ScaleX <span class="smalllinenumber">[line 8218]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void ScaleX(
float
$s_x, [int
$x = ''], [int
$y = ''])</code>
</td></tr></table>
</td></tr></table><br />
Horizontal Scaling.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">TCPDF::StartTransform()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">TCPDF::StopTransform()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$s_x</b>&nbsp;&nbsp;</td>
<td>scaling factor for width as percent. 0 is not allowed.</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>abscissa of the scaling center. Default is current x position</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>ordinate of the scaling center. Default is current y position</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodScaleXY"></a>
2010-03-20 13:26:55 +00:00
<h3>method ScaleXY <span class="smalllinenumber">[line 8244]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void ScaleXY(
float
$s, [int
$x = ''], [int
$y = ''])</code>
</td></tr></table>
</td></tr></table><br />
Vertical and horizontal proportional Scaling.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">TCPDF::StartTransform()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">TCPDF::StopTransform()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$s</b>&nbsp;&nbsp;</td>
<td>scaling factor for width and height as percent. 0 is not allowed.</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>abscissa of the scaling center. Default is current x position</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>ordinate of the scaling center. Default is current y position</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodScaleY"></a>
2010-03-20 13:26:55 +00:00
<h3>method ScaleY <span class="smalllinenumber">[line 8231]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void ScaleY(
float
$s_y, [int
$x = ''], [int
$y = ''])</code>
</td></tr></table>
</td></tr></table><br />
Vertical Scaling.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">TCPDF::StartTransform()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">TCPDF::StopTransform()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$s_y</b>&nbsp;&nbsp;</td>
<td>scaling factor for height as percent. 0 is not allowed.</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>abscissa of the scaling center. Default is current x position</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>ordinate of the scaling center. Default is current y position</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetAlpha"></a>
2010-03-20 13:26:55 +00:00
<h3>method setAlpha <span class="smalllinenumber">[line 11589]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setAlpha(
2010-01-14 14:02:19 +00:00
float
$alpha, [string
2009-03-24 18:37:18 +00:00
$bm = 'Normal'])</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Set alpha for stroking (CA) and non-stroking (ca) operations.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$alpha</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>real value from 0 (transparent) to 1 (opaque)</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$bm</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>blend mode, one of the following: Normal, Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, ColorBurn, HardLight, SoftLight, Difference, Exclusion, Hue, Saturation, Color, Luminosity</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetAuthor"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetAuthor <span class="smalllinenumber">[line 2221]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetAuthor(
string
$author)</code>
</td></tr></table>
</td></tr></table><br />
Defines the author of the document.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetCreator">TCPDF::SetCreator()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetKeywords">TCPDF::SetKeywords()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetSubject">TCPDF::SetSubject()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTitle">TCPDF::SetTitle()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.2</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$author</b>&nbsp;&nbsp;</td>
<td>The name of the author.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetAutoPageBreak"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetAutoPageBreak <span class="smalllinenumber">[line 2088]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetAutoPageBreak(
boolean
$auto, [float
$margin = 0])</code>
</td></tr></table>
</td></tr></table><br />
Enables or disables the automatic page breaking mode. When enabling, the second parameter is the distance from the bottom of the page that defines the triggering limit. By default, the mode is on and the margin is 2 cm.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodMultiCell">TCPDF::MultiCell()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodAcceptPageBreak">TCPDF::AcceptPageBreak()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$auto</b>&nbsp;&nbsp;</td>
<td>Boolean indicating if mode should be on or off.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$margin</b>&nbsp;&nbsp;</td>
<td>Distance from the bottom of the page.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetBarcode"></a>
2010-03-20 13:26:55 +00:00
<h3>method setBarcode <span class="smalllinenumber">[line 12267]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setBarcode(
[string
$bc = ''])</code>
</td></tr></table>
</td></tr></table><br />
Set document barcode.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$bc</b>&nbsp;&nbsp;</td>
<td>barcode</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetBooklet"></a>
2010-03-20 13:26:55 +00:00
<h3>method SetBooklet <span class="smalllinenumber">[line 15371]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetBooklet(
[boolean
$booklet = true], [float
$inner = -1], [float
$outer = -1])</code>
</td></tr></table>
</td></tr></table><br />
Set the booklet mode for double-sided pages.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.2.000 (2008-10-29)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$booklet</b>&nbsp;&nbsp;</td>
<td>true set the booklet mode on, fals eotherwise.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$inner</b>&nbsp;&nbsp;</td>
<td>Inner page margin.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$outer</b>&nbsp;&nbsp;</td>
<td>Outer page margin.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetBuffer"></a>
2010-03-20 13:26:55 +00:00
<h3>method setBuffer <span class="smalllinenumber">[line 15852]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setBuffer(
string
$data)</code>
</td></tr></table>
</td></tr></table><br />
Set buffer content (always append data).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2009-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$data</b>&nbsp;&nbsp;</td>
<td>data</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetCellHeightRatio"></a>
2010-03-20 13:26:55 +00:00
<h3>method setCellHeightRatio <span class="smalllinenumber">[line 11623]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setCellHeightRatio(
2010-01-14 14:02:19 +00:00
int
2009-03-24 18:37:18 +00:00
$h)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Set the height of the cell (line height) respect the font height.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.014 (2008-06-04)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$h</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>cell proportion respect font height (typical value = 1.25).</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetCellPadding"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetCellPadding <span class="smalllinenumber">[line 2076]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetCellPadding(
float
$pad)</code>
</td></tr></table>
</td></tr></table><br />
Set the internal Cell padding.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLeftMargin">TCPDF::SetLeftMargin()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTopMargin">TCPDF::SetTopMargin()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetAutoPageBreak">TCPDF::SetAutoPageBreak()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetMargins">TCPDF::SetMargins()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$pad</b>&nbsp;&nbsp;</td>
<td>internal padding.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetCompression"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetCompression <span class="smalllinenumber">[line 2181]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetCompression(
boolean
$compress)</code>
</td></tr></table>
</td></tr></table><br />
Activates or deactivates page compression. When activated, the internal representation of each page is compressed, which leads to a compression ratio of about 2 for the resulting document. Compression is on by default.<br /><br /><p>Note: the Zlib extension is required for this feature. If not present, compression will be turned off.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.4</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$compress</b>&nbsp;&nbsp;</td>
<td>Boolean indicating if compression must be enabled.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-07-20 13:44:38 +00:00
<hr />
<a name="methodsetContentMark"></a>
2010-03-13 19:49:15 +00:00
<h3>method setContentMark <span class="smalllinenumber">[line 2486]</span></h3>
2009-07-20 13:44:38 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setContentMark(
[int
$page = 0])</code>
</td></tr></table>
</td></tr></table><br />
Set start-writing mark on selected page.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.6.021 (2009-07-20)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$page</b>&nbsp;&nbsp;</td>
<td>page number (default is the current page)</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="methodSetCreator"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetCreator <span class="smalllinenumber">[line 2245]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetCreator(
string
$creator)</code>
</td></tr></table>
</td></tr></table><br />
Defines the creator of the document. This is typically the name of the application that generates the PDF.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetAuthor">TCPDF::SetAuthor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetKeywords">TCPDF::SetKeywords()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetSubject">TCPDF::SetSubject()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTitle">TCPDF::SetTitle()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.2</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$creator</b>&nbsp;&nbsp;</td>
<td>The name of the creator.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetDefaultMonospacedFont"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetDefaultMonospacedFont <span class="smalllinenumber">[line 3426]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetDefaultMonospacedFont(
string
$font)</code>
</td></tr></table>
</td></tr></table><br />
Defines the default monospaced font.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.025</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$font</b>&nbsp;&nbsp;</td>
<td>Font name.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetDefaultTableColumns"></a>
2010-03-20 13:26:55 +00:00
<h3>method setDefaultTableColumns <span class="smalllinenumber">[line 11613]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setDefaultTableColumns(
2010-01-14 14:02:19 +00:00
[int
2009-03-24 18:37:18 +00:00
$cols = 4])</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Set the default number of columns in a row for HTML tables.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.014 (2008-06-04)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$cols</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>number of columns</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetDisplayMode"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetDisplayMode <span class="smalllinenumber">[line 2103]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetDisplayMode(
mixed
$zoom, [string
$layout = 'SinglePage'], [string
$mode = 'UseNone'])</code>
</td></tr></table>
</td></tr></table><br />
Defines the way the document is to be displayed by the viewer.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.2</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$zoom</b>&nbsp;&nbsp;</td>
<td>The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use. <ul><li>fullpage: displays the entire page on screen</li><li>fullwidth: uses maximum width of window</li><li>real: uses real size (equivalent to 100% zoom)</li><li>default: uses viewer default mode</li></ul></td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$layout</b>&nbsp;&nbsp;</td>
<td>The page layout. Possible values are:<ul><li>SinglePage Display one page at a time</li><li>OneColumn Display the pages in one column</li><li>TwoColumnLeft Display the pages in two columns, with odd-numbered pages on the left</li><li>TwoColumnRight Display the pages in two columns, with odd-numbered pages on the right</li><li>TwoPageLeft (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the left</li><li>TwoPageRight (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the right</li></ul></td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$mode</b>&nbsp;&nbsp;</td>
<td>A name object specifying how the document should be displayed when opened:<ul><li>UseNone Neither document outline nor thumbnail images visible</li><li>UseOutlines Document outline visible</li><li>UseThumbs Thumbnail images visible</li><li>FullScreen Full-screen mode, with no menu bar, window controls, or any other window visible</li><li>UseOC (PDF 1.5) Optional content group panel visible</li><li>UseAttachments (PDF 1.6) Attachments panel visible</li></ul></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetDrawColor"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetDrawColor <span class="smalllinenumber">[line 2857]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetDrawColor(
[int
$col1 = 0], [int
$col2 = -1], [int
$col3 = -1], [int
$col4 = -1])</code>
</td></tr></table>
</td></tr></table><br />
Defines the color used for all drawing operations (lines, rectangles and cell borders). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetDrawColorArray">TCPDF::SetDrawColorArray()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFillColor">TCPDF::SetFillColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTextColor">TCPDF::SetTextColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodLine">TCPDF::Line()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodRect">TCPDF::Rect()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodMultiCell">TCPDF::MultiCell()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.3</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$col1</b>&nbsp;&nbsp;</td>
<td>Gray level for single color, or Red color for RGB, or Cyan color for CMYK. Value between 0 and 255</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$col2</b>&nbsp;&nbsp;</td>
<td>Green color for RGB, or Magenta color for CMYK. Value between 0 and 255</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$col3</b>&nbsp;&nbsp;</td>
<td>Blue color for RGB, or Yellow color for CMYK. Value between 0 and 255</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$col4</b>&nbsp;&nbsp;</td>
<td>Key (Black) color for CMYK. Value between 0 and 255</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetDrawColorArray"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetDrawColorArray <span class="smalllinenumber">[line 2834]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetDrawColorArray(
array
$color)</code>
</td></tr></table>
</td></tr></table><br />
Defines the color used for all drawing operations (lines, rectangles and cell borders).<br /><br /><p>It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetDrawColor">TCPDF::SetDrawColor()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-06-11)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$color</b>&nbsp;&nbsp;</td>
<td>array of colors</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetDrawSpotColor"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetDrawSpotColor <span class="smalllinenumber">[line 2895]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetDrawSpotColor(
string
$name, [int
$tint = 100])</code>
</td></tr></table>
</td></tr></table><br />
Defines the spot color used for all drawing operations (lines, rectangles and cell borders).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodAddSpotColor">TCPDF::AddSpotColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFillSpotColor">TCPDF::SetFillSpotColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTextSpotColor">TCPDF::SetTextSpotColor()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.024 (2008-09-12)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$name</b>&nbsp;&nbsp;</td>
<td>name of the spot color</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$tint</b>&nbsp;&nbsp;</td>
<td>the intensity of the color (from 0 to 100 ; 100 = full intensity by default).</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetExtGState"></a>
2010-03-20 13:26:55 +00:00
<h3>method setExtGState <span class="smalllinenumber">[line 11555]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setExtGState(
2010-01-14 14:02:19 +00:00
array
2009-03-24 18:37:18 +00:00
$gs)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Add an extgstate<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$gs</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>extgstate</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetFillColor"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetFillColor <span class="smalllinenumber">[line 2937]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetFillColor(
[int
$col1 = 0], [int
$col2 = -1], [int
$col3 = -1], [int
$col4 = -1])</code>
</td></tr></table>
</td></tr></table><br />
Defines the color used for all filling operations (filled rectangles and cell backgrounds). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFillColorArray">TCPDF::SetFillColorArray()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetDrawColor">TCPDF::SetDrawColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTextColor">TCPDF::SetTextColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodRect">TCPDF::Rect()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodMultiCell">TCPDF::MultiCell()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.3</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$col1</b>&nbsp;&nbsp;</td>
<td>Gray level for single color, or Red color for RGB, or Cyan color for CMYK. Value between 0 and 255</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$col2</b>&nbsp;&nbsp;</td>
<td>Green color for RGB, or Magenta color for CMYK. Value between 0 and 255</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$col3</b>&nbsp;&nbsp;</td>
<td>Blue color for RGB, or Yellow color for CMYK. Value between 0 and 255</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$col4</b>&nbsp;&nbsp;</td>
<td>Key (Black) color for CMYK. Value between 0 and 255</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetFillColorArray"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetFillColorArray <span class="smalllinenumber">[line 2914]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetFillColorArray(
array
$color)</code>
</td></tr></table>
</td></tr></table><br />
Defines the color used for all filling operations (filled rectangles and cell backgrounds).<br /><br /><p>It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFillColor">TCPDF::SetFillColor()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-6-11)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$color</b>&nbsp;&nbsp;</td>
<td>array of colors</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetFillSpotColor"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetFillSpotColor <span class="smalllinenumber">[line 2979]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetFillSpotColor(
string
$name, [int
$tint = 100])</code>
</td></tr></table>
</td></tr></table><br />
Defines the spot color used for all filling operations (filled rectangles and cell backgrounds).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodAddSpotColor">TCPDF::AddSpotColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetDrawSpotColor">TCPDF::SetDrawSpotColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTextSpotColor">TCPDF::SetTextSpotColor()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.024 (2008-09-12)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$name</b>&nbsp;&nbsp;</td>
<td>name of the spot color</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$tint</b>&nbsp;&nbsp;</td>
<td>the intensity of the color (from 0 to 100 ; 100 = full intensity by default).</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetFont"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetFont <span class="smalllinenumber">[line 3381]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetFont(
string
$family, [string
$style = ''], [float
$size = 0], [string
$fontfile = ''])</code>
</td></tr></table>
</td></tr></table><br />
Sets the font used to print character strings.<br /><br /><p>The font can be either a standard one or a font added via the AddFont() method. Standard fonts use Windows encoding cp1252 (Western Europe). The method can be called before the first page is created and the font is retained from page to page. If you just wish to change the current font size, it is simpler to call SetFontSize(). Note: for the standard fonts, the font metric files must be accessible. There are three possibilities for this:<ul><li>They are in the current directory (the one where the running script lies)</li><li>They are in one of the directories defined by the include_path parameter</li><li>They are in the directory defined by the K_PATH_FONTS constant</li></ul><br /></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodAddFont">TCPDF::AddFont()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFontSize">TCPDF::SetFontSize()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$family</b>&nbsp;&nbsp;</td>
<td>Family font. It can be either a name defined by AddFont() or one of the standard Type1 families (case insensitive):<ul><li>times (Times-Roman)</li><li>timesb (Times-Bold)</li><li>timesi (Times-Italic)</li><li>timesbi (Times-BoldItalic)</li><li>helvetica (Helvetica)</li><li>helveticab (Helvetica-Bold)</li><li>helveticai (Helvetica-Oblique)</li><li>helveticabi (Helvetica-BoldOblique)</li><li>courier (Courier)</li><li>courierb (Courier-Bold)</li><li>courieri (Courier-Oblique)</li><li>courierbi (Courier-BoldOblique)</li><li>symbol (Symbol)</li><li>zapfdingbats (ZapfDingbats)</li></ul> It is also possible to pass an empty string. In that case, the current family is retained.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>Font style. Possible values are (case insensitive):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li><li>D: line trough</li></ul> or any combination. The default value is regular. Bold and italic styles do not apply to Symbol and ZapfDingbats basic fonts or other fonts when not defined.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$size</b>&nbsp;&nbsp;</td>
<td>Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$fontfile</b>&nbsp;&nbsp;</td>
<td>The font definition file. By default, the name is built from the family and style, in lower case with no spaces.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetFontBuffer"></a>
2010-03-20 13:26:55 +00:00
<h3>method setFontBuffer <span class="smalllinenumber">[line 15988]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setFontBuffer(
string
$font, array
$data)</code>
</td></tr></table>
</td></tr></table><br />
Set font buffer content.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2009-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$font</b>&nbsp;&nbsp;</td>
<td>font key</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$data</b>&nbsp;&nbsp;</td>
<td>font data</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetFontSize"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetFontSize <span class="smalllinenumber">[line 3401]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetFontSize(
float
$size)</code>
</td></tr></table>
</td></tr></table><br />
Defines the size of the current font.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFont">TCPDF::SetFont()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$size</b>&nbsp;&nbsp;</td>
<td>The size (in points)</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetFontSubBuffer"></a>
2010-03-20 13:26:55 +00:00
<h3>method setFontSubBuffer <span class="smalllinenumber">[line 16010]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setFontSubBuffer(
string
$font, string
$key, array
$data)</code>
</td></tr></table>
</td></tr></table><br />
Set font buffer content.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2009-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$font</b>&nbsp;&nbsp;</td>
<td>font key</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$key</b>&nbsp;&nbsp;</td>
<td>font sub-key</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$data</b>&nbsp;&nbsp;</td>
<td>font data</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetFooter"></a>
2010-03-13 19:49:15 +00:00
<h3>method setFooter <span class="smalllinenumber">[line 2721]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setFooter(
)</code>
</td></tr></table>
</td></tr></table><br />
This method is used to render the page footer.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.012 (2008-07-24)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetFooterFont"></a>
2010-03-20 13:26:55 +00:00
<h3>method setFooterFont <span class="smalllinenumber">[line 7853]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setFooterFont(
array
$font)</code>
</td></tr></table>
</td></tr></table><br />
Set footer font.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$font</b>&nbsp;&nbsp;</td>
<td>font</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetFooterMargin"></a>
2010-03-13 19:49:15 +00:00
<h3>method setFooterMargin <span class="smalllinenumber">[line 2554]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setFooterMargin(
[int
$fm = 10])</code>
</td></tr></table>
</td></tr></table><br />
Set footer margin.<br /><br /><p>(minimum distance between footer and bottom page margin)</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$fm</b>&nbsp;&nbsp;</td>
<td>distance in user units</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-09-07 21:53:40 +00:00
<hr />
<a name="methodsetFormDefaultProp"></a>
2010-03-20 13:26:55 +00:00
<h3>method setFormDefaultProp <span class="smalllinenumber">[line 10651]</span></h3>
2009-09-07 21:53:40 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setFormDefaultProp(
2010-01-14 14:02:19 +00:00
[array
2009-09-07 21:53:40 +00:00
$prop = array()])</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Set default properties for form fields.<br /><br /><br /><br />
2009-09-07 21:53:40 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.000 (2009-09-06)</td>
</tr>
2009-09-07 21:53:40 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$prop</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>javascript field properties. Possible values are described on official Javascript for Acrobat API reference.</td>
2009-09-07 21:53:40 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="methodsetGraphicVars"></a>
2010-03-20 13:26:55 +00:00
<h3>method setGraphicVars <span class="smalllinenumber">[line 15769]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setGraphicVars(
$gvars
$gvars)</code>
</td></tr></table>
</td></tr></table><br />
Set graphic variables.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.2.010 (2008-11-14)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">$gvars&nbsp;&nbsp;</td>
<td><b>$gvars</b>&nbsp;&nbsp;</td>
<td>array graphic variables</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetHeader"></a>
2010-03-13 19:49:15 +00:00
<h3>method setHeader <span class="smalllinenumber">[line 2685]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setHeader(
)</code>
</td></tr></table>
</td></tr></table><br />
This method is used to render the page header.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.012 (2008-07-24)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetHeaderData"></a>
2010-03-13 19:49:15 +00:00
<h3>method setHeaderData <span class="smalllinenumber">[line 2505]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setHeaderData(
[string
$ln = ''], [string
$lw = 0], [string
$ht = ''], [string
$hs = ''])</code>
</td></tr></table>
</td></tr></table><br />
Set header data.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$ln</b>&nbsp;&nbsp;</td>
<td>header image logo</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$lw</b>&nbsp;&nbsp;</td>
<td>header image logo width in mm</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$ht</b>&nbsp;&nbsp;</td>
<td>string to print as title on document header</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$hs</b>&nbsp;&nbsp;</td>
<td>string to print on document header</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetHeaderFont"></a>
2010-03-20 13:26:55 +00:00
<h3>method setHeaderFont <span class="smalllinenumber">[line 7833]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setHeaderFont(
array
$font)</code>
</td></tr></table>
</td></tr></table><br />
Set header font.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$font</b>&nbsp;&nbsp;</td>
<td>font</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetHeaderMargin"></a>
2010-03-13 19:49:15 +00:00
<h3>method setHeaderMargin <span class="smalllinenumber">[line 2534]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setHeaderMargin(
[int
$hm = 10])</code>
</td></tr></table>
</td></tr></table><br />
Set header margin.<br /><br /><p>(minimum distance between header and top page margin)</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$hm</b>&nbsp;&nbsp;</td>
<td>distance in user units</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetHtmlLinksStyle"></a>
2010-03-20 13:26:55 +00:00
<h3>method setHtmlLinksStyle <span class="smalllinenumber">[line 15442]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setHtmlLinksStyle(
[array
$color = array(0,0,255)], [string
$fontstyle = 'U'])</code>
</td></tr></table>
</td></tr></table><br />
Set the color and font style for HTML links.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.4.003 (2008-12-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$color</b>&nbsp;&nbsp;</td>
<td>RGB array of colors</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$fontstyle</b>&nbsp;&nbsp;</td>
<td>additional font styles to add</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetHtmlVSpace"></a>
2010-03-20 13:26:55 +00:00
<h3>method setHtmlVSpace <span class="smalllinenumber">[line 15411]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setHtmlVSpace(
array
$tagvs)</code>
</td></tr></table>
</td></tr></table><br />
Set the vertical spaces for HTML tags.<br /><br /><p>The array must have the following structure (example): $tagvs = array('h1' =&gt; array(0 =&gt; array('h' =&gt; '', 'n' =&gt; 2), 1 =&gt; array('h' =&gt; 1.3, 'n' =&gt; 1))); The first array level contains the tag names, the second level contains 0 for opening tags or 1 for closing tags, the third level contains the vertical space unit (h) and the number spaces to add (n). If the h parameter is not specified, default values are used.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.2.001 (2008-10-30)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$tagvs</b>&nbsp;&nbsp;</td>
<td>array of tags and relative vertical spaces.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetImageBuffer"></a>
2010-03-20 13:26:55 +00:00
<h3>method setImageBuffer <span class="smalllinenumber">[line 15929]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setImageBuffer(
string
$image, array
$data)</code>
</td></tr></table>
</td></tr></table><br />
Set image buffer content.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2008-12-31)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$image</b>&nbsp;&nbsp;</td>
<td>image key</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$data</b>&nbsp;&nbsp;</td>
<td>image data</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetImageScale"></a>
2010-01-25 17:14:23 +00:00
<h3>method setImageScale <span class="smalllinenumber">[line 1910]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setImageScale(
float
$scale)</code>
</td></tr></table>
</td></tr></table><br />
2009-04-20 16:18:44 +00:00
Set the adjusting factor to convert pixels to user units.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.5.2</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$scale</b>&nbsp;&nbsp;</td>
2009-04-20 16:18:44 +00:00
<td>adjusting factor to convert pixels to user units.</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetImageSubBuffer"></a>
2010-03-20 13:26:55 +00:00
<h3>method setImageSubBuffer <span class="smalllinenumber">[line 15952]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setImageSubBuffer(
string
$image, string
$key, array
$data)</code>
</td></tr></table>
</td></tr></table><br />
2009-12-16 20:18:04 +00:00
Set image buffer content for a specified sub-key.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2008-12-31)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$image</b>&nbsp;&nbsp;</td>
<td>image key</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$key</b>&nbsp;&nbsp;</td>
<td>image sub-key</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$data</b>&nbsp;&nbsp;</td>
<td>image data</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetJPEGQuality"></a>
2010-03-20 13:26:55 +00:00
<h3>method setJPEGQuality <span class="smalllinenumber">[line 11600]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setJPEGQuality(
2010-01-14 14:02:19 +00:00
int
2009-03-24 18:37:18 +00:00
$quality)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Set the default JPEG compression quality (1-100)<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$quality</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>JPEG quality, integer between 1 and 100</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetKeywords"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetKeywords <span class="smalllinenumber">[line 2233]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetKeywords(
string
$keywords)</code>
</td></tr></table>
</td></tr></table><br />
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetAuthor">TCPDF::SetAuthor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetCreator">TCPDF::SetCreator()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetSubject">TCPDF::SetSubject()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTitle">TCPDF::SetTitle()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.2</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$keywords</b>&nbsp;&nbsp;</td>
<td>The list of keywords.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetLanguageArray"></a>
2010-03-20 13:26:55 +00:00
<h3>method setLanguageArray <span class="smalllinenumber">[line 7873]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setLanguageArray(
array
$language)</code>
</td></tr></table>
</td></tr></table><br />
Set language array.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$language</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetLastH"></a>
2010-01-25 17:14:23 +00:00
<h3>method setLastH <span class="smalllinenumber">[line 1889]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setLastH(
float
$h)</code>
</td></tr></table>
</td></tr></table><br />
Set the last cell height.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.53.0.TC034</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>cell height.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetLeftMargin"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetLeftMargin <span class="smalllinenumber">[line 2032]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetLeftMargin(
float
$margin)</code>
</td></tr></table>
</td></tr></table><br />
Defines the left margin. The method can be called before creating the first page. If the current abscissa gets out of page, it is brought back to the margin.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTopMargin">TCPDF::SetTopMargin()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetRightMargin">TCPDF::SetRightMargin()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetAutoPageBreak">TCPDF::SetAutoPageBreak()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetMargins">TCPDF::SetMargins()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.4</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$margin</b>&nbsp;&nbsp;</td>
<td>The margin.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetLineStyle"></a>
2010-03-20 13:26:55 +00:00
<h3>method SetLineStyle <span class="smalllinenumber">[line 8546]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetLineStyle(
array
$style)</code>
</td></tr></table>
</td></tr></table><br />
Set line style.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-08)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>Line style. Array with keys among the following: <ul><li>width (float): Width of the line in user units.</li><li>cap (string): Type of cap to put on the line. Possible values are:
butt, round, square. The difference between &quot;square&quot; and &quot;butt&quot; is that
&quot;square&quot; projects a flat end past the end of the line.</li><li>join (string): Type of join. Possible values are: miter, round,
bevel.</li><li>dash (mixed): Dash pattern. Is 0 (without dash) or string with
series of length values, which are the lengths of the on and off dashes.
For example: &quot;2&quot; represents 2 on, 2 off, 2 on, 2 off, ...; &quot;2,1&quot; is 2 on,
1 off, 2 on, 1 off, ...</li><li>phase (integer): Modifier on the dash pattern which is used to shift
the point at which the pattern starts.</li><li>color (array): Draw color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K).</li></ul></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetLineWidth"></a>
2010-03-20 13:26:55 +00:00
<h3>method SetLineWidth <span class="smalllinenumber">[line 8505]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetLineWidth(
float
$width)</code>
</td></tr></table>
</td></tr></table><br />
Defines the line width. By default, the value equals 0.2 mm. The method can be called before the first page is created and the value is retained from page to page.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodLine">TCPDF::Line()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodRect">TCPDF::Rect()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodMultiCell">TCPDF::MultiCell()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$width</b>&nbsp;&nbsp;</td>
<td>The width.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetLink"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetLink <span class="smalllinenumber">[line 3453]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetLink(
int
$link, [float
$y = 0], [int
$page = -1])</code>
</td></tr></table>
</td></tr></table><br />
Defines the page and position a link points to.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodAddLink">TCPDF::AddLink()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.5</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$link</b>&nbsp;&nbsp;</td>
<td>The link identifier returned by AddLink()</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page)</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$page</b>&nbsp;&nbsp;</td>
<td>Number of target page; -1 indicates the current page. This is the default value</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetListIndentWidth"></a>
2010-03-20 13:26:55 +00:00
<h3>method setListIndentWidth <span class="smalllinenumber">[line 15421]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setListIndentWidth(
float
$width)</code>
</td></tr></table>
</td></tr></table><br />
Set custom width for list indentation.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.2.007 (2008-11-12)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$width</b>&nbsp;&nbsp;</td>
<td>width of the indentation. Use negative value to disable it.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetLIsymbol"></a>
2010-03-20 13:26:55 +00:00
<h3>method setLIsymbol <span class="smalllinenumber">[line 15331]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setLIsymbol(
[string
$symbol = '!'])</code>
</td></tr></table>
</td></tr></table><br />
Set the default bullet to be used as LI bullet symbol<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.028 (2008-09-26)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$symbol</b>&nbsp;&nbsp;</td>
<td>character or string to be used (legal values are: '' = automatic, '!' = auto bullet, '#' = auto numbering, 'disc', 'disc', 'circle', 'square', '1', 'decimal', 'decimal-leading-zero', 'i', 'lower-roman', 'I', 'upper-roman', 'a', 'lower-alpha', 'lower-latin', 'A', 'upper-alpha', 'upper-latin', 'lower-greek')</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetMargins"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetMargins <span class="smalllinenumber">[line 2010]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetMargins(
float
$left, float
$top, [float
2010-03-13 19:49:15 +00:00
$right = -1], [boolean
$keepmargins = false])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
2010-03-13 19:49:15 +00:00
Defines the left, top and right margins.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLeftMargin">TCPDF::SetLeftMargin()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTopMargin">TCPDF::SetTopMargin()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetRightMargin">TCPDF::SetRightMargin()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetAutoPageBreak">TCPDF::SetAutoPageBreak()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$left</b>&nbsp;&nbsp;</td>
<td>Left margin.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$top</b>&nbsp;&nbsp;</td>
<td>Top margin.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$right</b>&nbsp;&nbsp;</td>
<td>Right margin. Default value is the left one.</td>
2010-03-13 19:49:15 +00:00
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$keepmargins</b>&nbsp;&nbsp;</td>
<td>if true overwrites the default page margins</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetOpenCell"></a>
2010-03-20 13:26:55 +00:00
<h3>method setOpenCell <span class="smalllinenumber">[line 15431]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setOpenCell(
boolean
$isopen)</code>
</td></tr></table>
</td></tr></table><br />
Set the top/bottom cell sides to be open or closed when the cell cross the page.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.2.010 (2008-11-14)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$isopen</b>&nbsp;&nbsp;</td>
<td>if true keeps the top/bottom border open for the cell sides that cross the page.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetPage"></a>
2010-03-13 19:49:15 +00:00
<h3>method setPage <span class="smalllinenumber">[line 2308]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setPage(
int
$pnum, [boolean
$resetmargins = false])</code>
</td></tr></table>
</td></tr></table><br />
Move pointer at the specified document page and update page dimensions.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodgetPage">TCPDF::getPage()</a>, lastpage(), <a href="../com-tecnick-tcpdf/TCPDF.html#methodgetNumPages">TCPDF::getNumPages()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$pnum</b>&nbsp;&nbsp;</td>
<td>page number</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$resetmargins</b>&nbsp;&nbsp;</td>
<td>if true reset left, right, top margins and Y position.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetPageBuffer"></a>
2010-03-20 13:26:55 +00:00
<h3>method setPageBuffer <span class="smalllinenumber">[line 15886]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setPageBuffer(
int
$page, string
$data, [boolean
$append = false])</code>
</td></tr></table>
</td></tr></table><br />
Set page buffer content.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2008-12-31)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$page</b>&nbsp;&nbsp;</td>
<td>page number</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$data</b>&nbsp;&nbsp;</td>
<td>page data</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$append</b>&nbsp;&nbsp;</td>
<td>if true append data, false replace.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetPageFormat"></a>
2010-01-25 17:14:23 +00:00
<h3>method setPageFormat <span class="smalllinenumber">[line 1689]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setPageFormat(
mixed
$format, [string
$orientation = 'P'])</code>
</td></tr></table>
</td></tr></table><br />
Set the page format<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.015 (2008-06-06)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$format</b>&nbsp;&nbsp;</td>
<td>The format used for pages. It can be either one of the following values (case insensitive) or a custom format in the form of a two-element array containing the width and the height (expressed in the unit given by unit).<ul><li>4A0</li><li>2A0</li><li>A0</li><li>A1</li><li>A2</li><li>A3</li><li>A4 (default)</li><li>A5</li><li>A6</li><li>A7</li><li>A8</li><li>A9</li><li>A10</li><li>B0</li><li>B1</li><li>B2</li><li>B3</li><li>B4</li><li>B5</li><li>B6</li><li>B7</li><li>B8</li><li>B9</li><li>B10</li><li>C0</li><li>C1</li><li>C2</li><li>C3</li><li>C4</li><li>C5</li><li>C6</li><li>C7</li><li>C8</li><li>C9</li><li>C10</li><li>RA0</li><li>RA1</li><li>RA2</li><li>RA3</li><li>RA4</li><li>SRA0</li><li>SRA1</li><li>SRA2</li><li>SRA3</li><li>SRA4</li><li>LETTER</li><li>LEGAL</li><li>EXECUTIVE</li><li>FOLIO</li></ul></td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$orientation</b>&nbsp;&nbsp;</td>
<td>page orientation. Possible values are (case insensitive):<ul><li>P or PORTRAIT (default)</li><li>L or LANDSCAPE</li></ul></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetPageMark"></a>
2010-03-13 19:49:15 +00:00
<h3>method setPageMark <span class="smalllinenumber">[line 2475]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setPageMark(
)</code>
</td></tr></table>
</td></tr></table><br />
Set start-writing mark on current page for multicell borders and fills.<br /><br /><p>This function must be called after calling Image() function for a background image. Background images must be always inserted before calling Multicell() or WriteHTMLCell() or WriteHTML() functions.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.016 (2008-07-30)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetPageOrientation"></a>
2010-01-25 17:14:23 +00:00
<h3>method setPageOrientation <span class="smalllinenumber">[line 1762]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setPageOrientation(
string
$orientation, [boolean
$autopagebreak = ''], [float
$bottommargin = ''])</code>
</td></tr></table>
</td></tr></table><br />
Set page orientation.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.015 (2008-06-06)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$orientation</b>&nbsp;&nbsp;</td>
<td>page orientation. Possible values are (case insensitive):<ul><li>P or PORTRAIT (default)</li><li>L or LANDSCAPE</li></ul></td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$autopagebreak</b>&nbsp;&nbsp;</td>
<td>Boolean indicating if auto-page-break mode should be on or off.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$bottommargin</b>&nbsp;&nbsp;</td>
<td>bottom margin of the page.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetPageUnit"></a>
2010-01-25 17:14:23 +00:00
<h3>method setPageUnit <span class="smalllinenumber">[line 1647]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setPageUnit(
string
$unit)</code>
</td></tr></table>
</td></tr></table><br />
Set the units of measure for the document.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.015 (2008-06-06)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$unit</b>&nbsp;&nbsp;</td>
<td>User measure unit. Possible values are:<ul><li>pt: point</li><li>mm: millimeter (default)</li><li>cm: centimeter</li><li>in: inch</li></ul><br />A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetPDFVersion"></a>
2010-03-20 13:26:55 +00:00
<h3>method setPDFVersion <span class="smalllinenumber">[line 11642]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setPDFVersion(
[
$version = '1.7'])</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Set the PDF version (check PDF reference for valid values).<br /><br /><p>Default value is 1.t</p><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-06-09)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$version</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetPrintFooter"></a>
2010-03-13 19:49:15 +00:00
<h3>method setPrintFooter <span class="smalllinenumber">[line 2581]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setPrintFooter(
[
$val = true], boolean
$value)</code>
</td></tr></table>
</td></tr></table><br />
Set a flag to print page footer.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$value</b>&nbsp;&nbsp;</td>
<td>set to true to print the page footer (default), false otherwise.</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$val</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetPrintHeader"></a>
2010-03-13 19:49:15 +00:00
<h3>method setPrintHeader <span class="smalllinenumber">[line 2572]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setPrintHeader(
[boolean
$val = true])</code>
</td></tr></table>
</td></tr></table><br />
Set a flag to print page header.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$val</b>&nbsp;&nbsp;</td>
<td>set to true to print the page header (default), false otherwise.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetProtection"></a>
2010-03-20 13:26:55 +00:00
<h3>method SetProtection <span class="smalllinenumber">[line 8158]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetProtection(
[Array
$permissions = array()], [String
$user_pass = ''], [String
$owner_pass = null])</code>
</td></tr></table>
</td></tr></table><br />
Set document protection<br /><br /><p>The permission array is composed of values taken from the following ones: <ul><li>copy: copy text and images to the clipboard</li><li>print: print the document</li><li>modify: modify it (except for annotations and forms)</li><li>annot-forms: add annotations and forms</li></ul> Remark: the protection against modification is for people who have the full Acrobat product. If you don't set any password, the document will open as usual. If you set a user password, the PDF viewer will ask for it before displaying the document. The master password, if different from the user one, can be used to get full access. Note: protecting a document requires to encrypt it, which increases the processing time a lot. This can cause a PHP time-out in some cases, especially if the document contains images or fonts.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Klemen Vodopivec</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000 (2008-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">Array&nbsp;&nbsp;</td>
<td><b>$permissions</b>&nbsp;&nbsp;</td>
<td>the set of permissions. Empty by default (only viewing is allowed). (print, modify, copy, annot-forms)</td>
</tr>
<tr>
<td class="type">String&nbsp;&nbsp;</td>
<td><b>$user_pass</b>&nbsp;&nbsp;</td>
<td>user password. Empty by default.</td>
</tr>
<tr>
<td class="type">String&nbsp;&nbsp;</td>
<td><b>$owner_pass</b>&nbsp;&nbsp;</td>
<td>owner password. If not specified, a random value is used.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetRightMargin"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetRightMargin <span class="smalllinenumber">[line 2062]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetRightMargin(
float
$margin)</code>
</td></tr></table>
</td></tr></table><br />
Defines the right margin. The method can be called before creating the first page.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLeftMargin">TCPDF::SetLeftMargin()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTopMargin">TCPDF::SetTopMargin()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetAutoPageBreak">TCPDF::SetAutoPageBreak()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetMargins">TCPDF::SetMargins()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.5</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$margin</b>&nbsp;&nbsp;</td>
<td>The margin.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetRTL"></a>
2010-01-25 17:14:23 +00:00
<h3>method setRTL <span class="smalllinenumber">[line 1818]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setRTL(
Boolean
2009-07-16 12:48:21 +00:00
$enable, [Boolean
$resetx = true])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
Enable or disable Right-To-Left language mode<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000 (2008-01-03)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">Boolean&nbsp;&nbsp;</td>
<td><b>$enable</b>&nbsp;&nbsp;</td>
<td>if true enable Right-To-Left language mode.</td>
2009-07-16 12:48:21 +00:00
</tr>
<tr>
<td class="type">Boolean&nbsp;&nbsp;</td>
<td><b>$resetx</b>&nbsp;&nbsp;</td>
<td>if true reset the X position on direction change.</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-04-25 08:54:01 +00:00
<hr />
<a name="methodsetSignature"></a>
2010-03-20 13:26:55 +00:00
<h3>method setSignature <span class="smalllinenumber">[line 11301]</span></h3>
2009-04-25 08:54:01 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setSignature(
2010-01-14 14:02:19 +00:00
[mixed
$signing_cert = ''], [mixed
$private_key = ''], [string
$private_key_password = ''], [string
$extracerts = ''], [int
$cert_type = 2], [array
2009-05-07 13:08:11 +00:00
$info = array()])</code>
2009-04-25 08:54:01 +00:00
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Enable document signature (requires the OpenSSL Library).<br /><br /><p>The digital signature improve document authenticity and integrity and allows o enable extra features on Acrobat Reader.</p><br /><br /><br />
2009-04-25 08:54:01 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.6.005 (2009-04-24)</td>
</tr>
2009-04-25 08:54:01 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">mixed&nbsp;&nbsp;</td>
2009-04-25 08:54:01 +00:00
<td><b>$signing_cert</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>signing certificate (string or filename prefixed with 'file://')</td>
2009-04-25 08:54:01 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">mixed&nbsp;&nbsp;</td>
2009-04-25 08:54:01 +00:00
<td><b>$private_key</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>private key (string or filename prefixed with 'file://')</td>
2009-04-25 08:54:01 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-04-25 08:54:01 +00:00
<td><b>$private_key_password</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>password</td>
2009-04-25 08:54:01 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-04-25 08:54:01 +00:00
<td><b>$extracerts</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>specifies the name of a file containing a bunch of extra certificates to include in the signature which can for example be used to help the recipient to verify the certificate that you used.</td>
2009-05-07 13:08:11 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-05-07 13:08:11 +00:00
<td><b>$cert_type</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>The access permissions granted for this document. Valid values shall be: 1 = No changes to the document shall be permitted; any change to the document shall invalidate the signature; 2 = Permitted changes shall be filling in forms, instantiating page templates, and signing; other changes shall invalidate the signature; 3 = Permitted changes shall be the same as for 2, as well as annotation creation, deletion, and modification; other changes shall invalidate the signature.</td>
2009-05-07 13:08:11 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-05-07 13:08:11 +00:00
<td><b>$info</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>array of option information: Name, Location, Reason, ContactInfo.</td>
2009-04-25 08:54:01 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-06-15 12:18:24 +00:00
<hr />
<a name="methodsetSpacesRE"></a>
2010-01-25 17:14:23 +00:00
<h3>method setSpacesRE <span class="smalllinenumber">[line 1803]</span></h3>
2009-06-15 12:18:24 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setSpacesRE(
[string
$re = '/[\s]/'])</code>
</td></tr></table>
</td></tr></table><br />
Set regular expression to detect withespaces or word separators.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.6.016 (2009-06-15)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$re</b>&nbsp;&nbsp;</td>
<td>regular expression (leave empty for default).</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="methodSetSubject"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetSubject <span class="smalllinenumber">[line 2209]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetSubject(
string
$subject)</code>
</td></tr></table>
</td></tr></table><br />
Defines the subject of the document.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetAuthor">TCPDF::SetAuthor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetCreator">TCPDF::SetCreator()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetKeywords">TCPDF::SetKeywords()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTitle">TCPDF::SetTitle()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.2</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$subject</b>&nbsp;&nbsp;</td>
<td>The subject.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetTableHeader"></a>
2010-03-13 19:49:15 +00:00
<h3>method setTableHeader <span class="smalllinenumber">[line 2767]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setTableHeader(
)</code>
</td></tr></table>
</td></tr></table><br />
This method is used to render the table header on new page (if any).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.030 (2009-03-25)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetTempRTL"></a>
2010-01-25 17:14:23 +00:00
<h3>method setTempRTL <span class="smalllinenumber">[line 1844]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setTempRTL(
mixed
$mode)</code>
</td></tr></table>
</td></tr></table><br />
Force temporary RTL language direction<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$mode</b>&nbsp;&nbsp;</td>
<td>can be false, 'L' for LTR or 'R' for RTL</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetTextColor"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetTextColor <span class="smalllinenumber">[line 3021]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetTextColor(
[int
$col1 = 0], [int
$col2 = -1], [int
$col3 = -1], [int
$col4 = -1])</code>
</td></tr></table>
</td></tr></table><br />
Defines the color used for text. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetTextColorArray">TCPDF::SetTextColorArray()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetDrawColor">TCPDF::SetDrawColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFillColor">TCPDF::SetFillColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodText">TCPDF::Text()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodMultiCell">TCPDF::MultiCell()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.3</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$col1</b>&nbsp;&nbsp;</td>
<td>Gray level for single color, or Red color for RGB, or Cyan color for CMYK. Value between 0 and 255</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$col2</b>&nbsp;&nbsp;</td>
<td>Green color for RGB, or Magenta color for CMYK. Value between 0 and 255</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$col3</b>&nbsp;&nbsp;</td>
<td>Blue color for RGB, or Yellow color for CMYK. Value between 0 and 255</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$col4</b>&nbsp;&nbsp;</td>
<td>Key (Black) color for CMYK. Value between 0 and 255</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetTextColorArray"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetTextColorArray <span class="smalllinenumber">[line 2998]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetTextColorArray(
array
$color)</code>
</td></tr></table>
</td></tr></table><br />
Defines the color used for text. It can be expressed in RGB components or gray scale.<br /><br /><p>The method can be called before the first page is created and the value is retained from page to page.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFillColor">TCPDF::SetFillColor()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-6-11)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$color</b>&nbsp;&nbsp;</td>
<td>array of colors</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetTextSpotColor"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetTextSpotColor <span class="smalllinenumber">[line 3060]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetTextSpotColor(
string
$name, [int
$tint = 100])</code>
</td></tr></table>
</td></tr></table><br />
Defines the spot color used for text.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodAddSpotColor">TCPDF::AddSpotColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetDrawSpotColor">TCPDF::SetDrawSpotColor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetFillSpotColor">TCPDF::SetFillSpotColor()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.024 (2008-09-12)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$name</b>&nbsp;&nbsp;</td>
<td>name of the spot color</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$tint</b>&nbsp;&nbsp;</td>
<td>the intensity of the color (from 0 to 100 ; 100 = full intensity by default).</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetTitle"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetTitle <span class="smalllinenumber">[line 2197]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetTitle(
string
$title)</code>
</td></tr></table>
</td></tr></table><br />
Defines the title of the document.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetAuthor">TCPDF::SetAuthor()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetCreator">TCPDF::SetCreator()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetKeywords">TCPDF::SetKeywords()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetSubject">TCPDF::SetSubject()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.2</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$title</b>&nbsp;&nbsp;</td>
<td>The title.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetTopMargin"></a>
2010-03-13 19:49:15 +00:00
<h3>method SetTopMargin <span class="smalllinenumber">[line 2047]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetTopMargin(
float
$margin)</code>
</td></tr></table>
</td></tr></table><br />
Defines the top margin. The method can be called before creating the first page.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLeftMargin">TCPDF::SetLeftMargin()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetRightMargin">TCPDF::SetRightMargin()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetAutoPageBreak">TCPDF::SetAutoPageBreak()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetMargins">TCPDF::SetMargins()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.5</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$margin</b>&nbsp;&nbsp;</td>
<td>The margin.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetUserRights"></a>
2010-03-20 13:26:55 +00:00
<h3>method setUserRights <span class="smalllinenumber">[line 11271]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setUserRights(
2010-01-14 14:02:19 +00:00
[boolean
$enable = true], [string
$document = '/FullSave'], [string
$annots = '/Create/Delete/Modify/Copy/Import/Export'], [string
$form = '/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate'], [string
2009-03-24 18:37:18 +00:00
$signature = '/Modify'])</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Set User's Rights for PDF Reader WARNING: This works only using the Adobe private key with the setSignature() method!.<br /><br /><p>Check the PDF Reference 8.7.1 Transform Methods, Table 8.105 Entries in the UR transform parameters dictionary</p><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.9.000 (2008-03-26)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">boolean&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$enable</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>if true enable user's rights on PDF reader</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$document</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Names specifying additional document-wide usage rights for the document. The only defined value is &quot;/FullSave&quot;, which permits a user to save the document along with modified form and/or annotation data.</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$annots</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Names specifying additional annotation-related usage rights for the document. Valid names in PDF 1.5 and later are /Create/Delete/Modify/Copy/Import/Export, which permit the user to perform the named operation on annotations.</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$form</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Names specifying additional form-field-related usage rights for the document. Valid names are: /Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$signature</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Names specifying additional signature-related usage rights for the document. The only defined value is /Modify, which permits a user to apply a digital signature to an existing signature form field or clear a signed signature form field.</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetViewerPreferences"></a>
2010-03-20 13:26:55 +00:00
<h3>method setViewerPreferences <span class="smalllinenumber">[line 11655]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setViewerPreferences(
2010-01-14 14:02:19 +00:00
array
2009-03-24 18:37:18 +00:00
$preferences)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Set the viewer preferences dictionary controlling the way the document is to be presented on the screen or in print.<br /><br /><p>(see Section 8.1 of PDF reference, &quot;Viewer Preferences&quot;). <ul><li>HideToolbar boolean (Optional) A flag specifying whether to hide the viewer application's tool bars when the document is active. Default value: false.</li><li>HideMenubar boolean (Optional) A flag specifying whether to hide the viewer application's menu bar when the document is active. Default value: false.</li><li>HideWindowUI boolean (Optional) A flag specifying whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed. Default value: false.</li><li>FitWindow boolean (Optional) A flag specifying whether to resize the document's window to fit the size of the first displayed page. Default value: false.</li><li>CenterWindow boolean (Optional) A flag specifying whether to position the document's window in the center of the screen. Default value: false.</li><li>DisplayDocTitle boolean (Optional; PDF 1.4) A flag specifying whether the window's title bar should display the document title taken from the Title entry of the document information dictionary (see Section 10.2.1, &quot;Document Information Dictionary&quot;). If false, the title bar should instead display the name of the PDF file containing the document. Default value: false.</li><li>NonFullScreenPageMode name (Optional) The document's page mode, specifying how to display the document on exiting full-screen mode:<ul><li>UseNone Neither document outline nor thumbnail images visible</li><li>UseOutlines Document outline visible</li><li>UseThumbs Thumbnail images visible</li><li>UseOC Optional content group panel visible</li></ul>This entry is meaningful only if the value of the PageMode entry in the catalog dictionary (see Section 3.6.1, &quot;Document Catalog&quot;) is FullScreen; it is ignored otherwise. Default value: UseNone.</li><li>ViewArea name (Optional; PDF 1.4) The name of the page boundary representing the area of a page to be displayed when viewing the document on the screen. Valid values are (see Section 10.10.1, &quot;Page Boundaries&quot;).:<ul><li>MediaBox</li><li>CropBox (default)</li><li>BleedBox</li><li>TrimBox</li><li>ArtBox</li></ul></li><li>ViewClip name (Optional; PDF 1.4) The name of the page boundary to which the contents of a page are to be clipped when viewing the document on the screen. Valid values are (see Section 10.10.1, &quot;Page Boundaries&quot;).:<ul><li>MediaBox</li><li>CropBox (default)</li><li>BleedBox</li><li>TrimBox</li><li>ArtBox</li></ul></li><li>PrintArea name (Optional; PDF 1.4) The name of the page boundary representing the area of a page to be rendered when printing the document. Valid values are (see Section 10.10.1, &quot;Page Boundaries&quot;).:<ul><li>MediaBox</li><li>CropBox (default)</li><li>BleedBox</li><li>TrimBox</li><li>ArtBox</li></ul></li><li>PrintClip name (Optional; PDF 1.4) The name of the page boundary to which the contents of a page are to be clipped when printing the document. Valid values are (see Section 10.10.1, &quot;Page Boundaries&quot;).:<ul><li>MediaBox</li><li>CropBox (default)</li><li>BleedBox</li><li>TrimBox</li><li>ArtBox</li></ul></li><li>PrintScaling name (Optional; PDF 1.6) The page scaling option to be selected when a print dialog is displayed for this document. Valid values are: <ul><li>None, which indicates that the print dialog should reflect no page scaling</li><li>AppDefault (default), which indicates that applications should use the current print scaling</li></ul></li><li>Duplex name (Optional; PDF 1.7) The paper handling option to use when printing the file from the print dialog. The following values are valid:<ul><li>Simplex - Print single-sided</li><li>DuplexFlipShortEdge - Duplex and flip on the short edge of the sheet</li><li>DuplexFlipLongEdge - Duplex and flip on the long edge of the sheet</li></ul>Default value: none</li><li>PickTrayByPDFSize boolean (Optional; PDF 1.7)
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-06-09)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$preferences</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>array of options.</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetVisibility"></a>
2010-03-20 13:26:55 +00:00
<h3>method setVisibility <span class="smalllinenumber">[line 11500]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setVisibility(
2010-01-14 14:02:19 +00:00
string
2009-03-24 18:37:18 +00:00
$v)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Set the visibility of the successive elements.<br /><br /><p>This can be useful, for instance, to put a background image or color that will show on screen but won't print.</p><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$v</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>visibility mode. Legal values are: all, print, screen.</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetX"></a>
2010-03-20 13:26:55 +00:00
<h3>method SetX <span class="smalllinenumber">[line 5344]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetX(
float
$x)</code>
</td></tr></table>
</td></tr></table><br />
Defines the abscissa of the current position.<br /><br /><p>If the passed value is negative, it is relative to the right of the page (or left if language is RTL).</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodGetX">TCPDF::GetX()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodGetY">TCPDF::GetY()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetY">TCPDF::SetY()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetXY">TCPDF::SetXY()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.2</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>The value of the abscissa.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetXY"></a>
2010-03-20 13:26:55 +00:00
<h3>method SetXY <span class="smalllinenumber">[line 5407]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetXY(
float
$x, float
$y)</code>
</td></tr></table>
</td></tr></table><br />
Defines the abscissa and ordinate of the current position.<br /><br /><p>If the passed values are negative, they are relative respectively to the right and bottom of the page.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodSetX">TCPDF::SetX()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetY">TCPDF::SetY()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.2</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>The value of the abscissa</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>The value of the ordinate</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSetY"></a>
2010-03-20 13:26:55 +00:00
<h3>method SetY <span class="smalllinenumber">[line 5376]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SetY(
float
$y, [bool
$resetx = true])</code>
</td></tr></table>
</td></tr></table><br />
Moves the current abscissa back to the left margin and sets the ordinate.<br /><br /><p>If the passed value is negative, it is relative to the bottom of the page.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodGetX">TCPDF::GetX()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodGetY">TCPDF::GetY()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetY">TCPDF::SetY()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetXY">TCPDF::SetXY()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>The value of the ordinate.</td>
</tr>
<tr>
<td class="type">bool&nbsp;&nbsp;</td>
<td><b>$resetx</b>&nbsp;&nbsp;</td>
<td>if true (default) reset the X position.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-08-17 16:00:15 +00:00
<hr />
<a name="methodset_mqr"></a>
2010-03-20 13:26:55 +00:00
<h3>method set_mqr <span class="smalllinenumber">[line 5008]</span></h3>
2009-08-17 16:00:15 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void set_mqr(
boolean
$mqr)</code>
</td></tr></table>
</td></tr></table><br />
Sets the current active configuration setting of magic_quotes_runtime (if the set_magic_quotes_runtime function exist)<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.6.025 (2009-08-17)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$mqr</b>&nbsp;&nbsp;</td>
<td>FALSE for off, TRUE for on.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="methodSkew"></a>
2010-03-20 13:26:55 +00:00
<h3>method Skew <span class="smalllinenumber">[line 8448]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Skew(
float
$angle_x, float
$angle_y, [int
$x = ''], [int
$y = ''])</code>
</td></tr></table>
</td></tr></table><br />
Skew.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">TCPDF::StartTransform()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">TCPDF::StopTransform()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$angle_x</b>&nbsp;&nbsp;</td>
<td>angle in degrees between -90 (skew to the left) and 90 (skew to the right)</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$angle_y</b>&nbsp;&nbsp;</td>
<td>angle in degrees between -90 (skew to the bottom) and 90 (skew to the top)</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>abscissa of the skewing center. default is current x position</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>ordinate of the skewing center. default is current y position</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSkewX"></a>
2010-03-20 13:26:55 +00:00
<h3>method SkewX <span class="smalllinenumber">[line 8421]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SkewX(
float
$angle_x, [int
$x = ''], [int
$y = ''])</code>
</td></tr></table>
</td></tr></table><br />
Skew horizontally.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">TCPDF::StartTransform()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">TCPDF::StopTransform()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$angle_x</b>&nbsp;&nbsp;</td>
<td>angle in degrees between -90 (skew to the left) and 90 (skew to the right)</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>abscissa of the skewing center. default is current x position</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>ordinate of the skewing center. default is current y position</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodSkewY"></a>
2010-03-20 13:26:55 +00:00
<h3>method SkewY <span class="smalllinenumber">[line 8434]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void SkewY(
float
$angle_y, [int
$x = ''], [int
$y = ''])</code>
</td></tr></table>
</td></tr></table><br />
Skew vertically.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">TCPDF::StartTransform()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">TCPDF::StopTransform()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$angle_y</b>&nbsp;&nbsp;</td>
<td>angle in degrees between -90 (skew to the bottom) and 90 (skew to the top)</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>abscissa of the skewing center. default is current x position</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>ordinate of the skewing center. default is current y position</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodStarPolygon"></a>
2010-03-20 13:26:55 +00:00
<h3>method StarPolygon <span class="smalllinenumber">[line 9264]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void StarPolygon(
float
$x0, float
$y0, float
$r, integer
$nv, integer
$ng, [
$angle = 0], [
$draw_circle = false], [string
$style = ''], [array
$line_style = array()], [array
$fill_color = array()], [string
$circle_style = ''], [array
$circle_outLine_style = array()], [array
$circle_fill_color = array()], float
$angle:, boolean
$draw_circle:)</code>
</td></tr></table>
</td></tr></table><br />
Draws a star polygon<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-08)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x0</b>&nbsp;&nbsp;</td>
<td>Abscissa of center point.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y0</b>&nbsp;&nbsp;</td>
<td>Ordinate of center point.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$r</b>&nbsp;&nbsp;</td>
<td>Radius of inscribed circle.</td>
</tr>
<tr>
<td class="type">integer&nbsp;&nbsp;</td>
<td><b>$nv</b>&nbsp;&nbsp;</td>
<td>Number of vertices.</td>
</tr>
<tr>
<td class="type">integer&nbsp;&nbsp;</td>
<td><b>$ng</b>&nbsp;&nbsp;</td>
<td>Number of gap (if ($ng % $nv = 1) then is a regular polygon).</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$angle:</b>&nbsp;&nbsp;</td>
<td>Angle oriented (anti-clockwise). Default value: 0.</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$draw_circle:</b>&nbsp;&nbsp;</td>
<td>Draw inscribed circle or not. Default value is false.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>Style of rendering. Possible values are: <ul><li>D or empty string: Draw (default).</li><li>F: Fill.</li><li>DF or FD: Draw and fill.</li><li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li><li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li></ul></td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$line_style</b>&nbsp;&nbsp;</td>
<td>Line style of polygon sides. Array with keys among the following: <ul><li>all: Line style of all sides. Array like for
<a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">SetLineStyle</a>.</li><li>0 to (n - 1): Line style of each side. Array like for <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">SetLineStyle</a>.</li></ul> If a key is not present or is null, not draws the side. Default value is default line style (empty array).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$fill_color</b>&nbsp;&nbsp;</td>
<td>Fill color. Format: array(red, green, blue). Default value: default color (empty array).</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$circle_style</b>&nbsp;&nbsp;</td>
<td>Style of rendering of inscribed circle (if draws). Possible values are: <ul><li>D or empty string: Draw (default).</li><li>F: Fill.</li><li>DF or FD: Draw and fill.</li><li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li><li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li></ul></td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$circle_outLine_style</b>&nbsp;&nbsp;</td>
<td>Line style of inscribed circle (if draws). Array like for <a href="../com-tecnick-tcpdf/TCPDF.html#methodSetLineStyle">SetLineStyle</a>. Default value: default line style (empty array).</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$circle_fill_color</b>&nbsp;&nbsp;</td>
<td>Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array).</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$angle</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$draw_circle</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodstartPage"></a>
2010-03-13 19:49:15 +00:00
<h3>method startPage <span class="smalllinenumber">[line 2435]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void startPage(
[string
$orientation = ''], [mixed
$format = ''])</code>
</td></tr></table>
</td></tr></table><br />
Starts a new page to the document. The page must be closed using the endPage() function.<br /><br /><p>The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodendPage">TCPDF::endPage()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodAddPage">TCPDF::AddPage()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.2.010 (2008-11-14)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$orientation</b>&nbsp;&nbsp;</td>
<td>page orientation. Possible values are (case insensitive):<ul><li>P or PORTRAIT (default)</li><li>L or LANDSCAPE</li></ul></td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$format</b>&nbsp;&nbsp;</td>
<td>The format used for pages. It can be either one of the following values (case insensitive) or a custom format in the form of a two-element array containing the width and the height (expressed in the unit given by unit).<ul><li>4A0</li><li>2A0</li><li>A0</li><li>A1</li><li>A2</li><li>A3</li><li>A4 (default)</li><li>A5</li><li>A6</li><li>A7</li><li>A8</li><li>A9</li><li>A10</li><li>B0</li><li>B1</li><li>B2</li><li>B3</li><li>B4</li><li>B5</li><li>B6</li><li>B7</li><li>B8</li><li>B9</li><li>B10</li><li>C0</li><li>C1</li><li>C2</li><li>C3</li><li>C4</li><li>C5</li><li>C6</li><li>C7</li><li>C8</li><li>C9</li><li>C10</li><li>RA0</li><li>RA1</li><li>RA2</li><li>RA3</li><li>RA4</li><li>SRA0</li><li>SRA1</li><li>SRA2</li><li>SRA3</li><li>SRA4</li><li>LETTER</li><li>LEGAL</li><li>EXECUTIVE</li><li>FOLIO</li></ul></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodstartPageGroup"></a>
2010-03-20 13:26:55 +00:00
<h3>method startPageGroup <span class="smalllinenumber">[line 11329]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void startPageGroup(
2010-01-14 14:02:19 +00:00
[int
2009-03-24 18:37:18 +00:00
$page = ''])</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Create a new page group.<br /><br /><p>NOTE: call this function before calling AddPage()</p><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$page</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>starting group page (leave empty for next page).</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodstartTransaction"></a>
2010-03-20 13:26:55 +00:00
<h3>method startTransaction <span class="smalllinenumber">[line 16468]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void startTransaction(
)</code>
</td></tr></table>
</td></tr></table><br />
2009-04-20 16:18:44 +00:00
Stores a copy of the current TCPDF object used for undo operation.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.029 (2009-03-19)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodStartTransform"></a>
2010-03-20 13:26:55 +00:00
<h3>method StartTransform <span class="smalllinenumber">[line 8186]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void StartTransform(
)</code>
</td></tr></table>
</td></tr></table><br />
Starts a 2D tranformation saving current graphic state.<br /><br /><p>This function must be called before scaling, mirroring, translation, rotation and skewing. Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">TCPDF::StartTransform()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">TCPDF::StopTransform()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodStopTransform"></a>
2010-03-20 13:26:55 +00:00
<h3>method StopTransform <span class="smalllinenumber">[line 8201]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void StopTransform(
)</code>
</td></tr></table>
</td></tr></table><br />
Stops a 2D tranformation restoring previous graphic state.<br /><br /><p>This function must be called after scaling, mirroring, translation, rotation and skewing. Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">TCPDF::StartTransform()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">TCPDF::StopTransform()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodswapMargins"></a>
2010-03-20 13:26:55 +00:00
<h3>method swapMargins <span class="smalllinenumber">[line 15387]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void swapMargins(
[boolean
$reverse = true])</code>
</td></tr></table>
</td></tr></table><br />
Swap the left and right margins.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.2.000 (2008-10-29)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$reverse</b>&nbsp;&nbsp;</td>
<td>if true swap left and right margins.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodText"></a>
2010-03-13 19:49:15 +00:00
<h3>method Text <span class="smalllinenumber">[line 3604]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Text(
float
$x, float
$y, string
$txt, [int
$stroke = 0], [boolean
$clip = false])</code>
</td></tr></table>
</td></tr></table><br />
Prints a character string.<br /><br /><p>The origin is on the left of the first charcter, on the baseline. This method allows to place a string precisely on the page.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodWrite">TCPDF::Write()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodMultiCell">TCPDF::MultiCell()</a>, WriteHTML(), WriteHTMLCell()</td>
</tr>
<tr>
<td><b>deprecated:</b>&nbsp;&nbsp;</td><td>deprecated since version 4.3.005 (2008-11-25)</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>Abscissa of the origin</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>Ordinate of the origin</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$txt</b>&nbsp;&nbsp;</td>
<td>String to print</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$stroke</b>&nbsp;&nbsp;</td>
<td>outline size in points (0 = disable)</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$clip</b>&nbsp;&nbsp;</td>
<td>if true activate clipping mode (you must call StartTransform() before this function and StopTransform() to stop the clipping tranformation).</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodTextField"></a>
2010-03-20 13:26:55 +00:00
<h3>method TextField <span class="smalllinenumber">[line 10680]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void TextField(
2010-01-14 14:02:19 +00:00
string
$name, float
$w, float
$h, [array
$prop = array()], [array
$opt = array()], [float
$x = ''], [float
$y = ''], [boolean
2009-09-07 21:53:40 +00:00
$js = false])</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Creates a text field<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.000 (2009-09-07)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$name</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>field name</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$w</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Width of the rectangle</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$h</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Height of the rectangle</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$prop</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>javascript field properties. Possible values are described on official Javascript for Acrobat API reference.</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$opt</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>annotation parameters. Possible values are described on official PDF32000_2008 reference.</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$x</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Abscissa of the upper-left corner of the rectangle</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$y</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Ordinate of the upper-left corner of the rectangle</td>
2009-09-07 21:53:40 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">boolean&nbsp;&nbsp;</td>
2009-09-07 21:53:40 +00:00
<td><b>$js</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>if true put the field using JavaScript (requires Acrobat Writer to be rendered).</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodTransform"></a>
2010-03-20 13:26:55 +00:00
<h3>method Transform <span class="smalllinenumber">[line 8481]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Transform(
$tm)</code>
</td></tr></table>
</td></tr></table><br />
Apply graphic transformations.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">TCPDF::StartTransform()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">TCPDF::StopTransform()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$tm</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodTranslate"></a>
2010-03-20 13:26:55 +00:00
<h3>method Translate <span class="smalllinenumber">[line 8364]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void Translate(
int
$t_x, int
$t_y)</code>
</td></tr></table>
</td></tr></table><br />
Translate graphic object horizontally and vertically.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">TCPDF::StartTransform()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">TCPDF::StopTransform()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$t_x</b>&nbsp;&nbsp;</td>
<td>movement to the right</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$t_y</b>&nbsp;&nbsp;</td>
<td>movement to the bottom</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodTranslateX"></a>
2010-03-20 13:26:55 +00:00
<h3>method TranslateX <span class="smalllinenumber">[line 8341]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void TranslateX(
int
$t_x)</code>
</td></tr></table>
</td></tr></table><br />
Translate graphic object horizontally.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">TCPDF::StartTransform()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">TCPDF::StopTransform()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$t_x</b>&nbsp;&nbsp;</td>
<td>movement to the right (or left for RTL)</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodTranslateY"></a>
2010-03-20 13:26:55 +00:00
<h3>method TranslateY <span class="smalllinenumber">[line 8352]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void TranslateY(
int
$t_y)</code>
</td></tr></table>
</td></tr></table><br />
Translate graphic object vertically.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodStartTransform">TCPDF::StartTransform()</a>, <a href="../com-tecnick-tcpdf/TCPDF.html#methodStopTransform">TCPDF::StopTransform()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$t_y</b>&nbsp;&nbsp;</td>
<td>movement to the bottom</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodunhtmlentities"></a>
2010-03-20 13:26:55 +00:00
<h3>method unhtmlentities <span class="smalllinenumber">[line 8006]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string unhtmlentities(
$text_to_convert
$text_to_convert)</code>
</td></tr></table>
</td></tr></table><br />
Reverse function for htmlentities.<br /><br /><p>Convert entities in UTF-8.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>converted</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">$text_to_convert&nbsp;&nbsp;</td>
<td><b>$text_to_convert</b>&nbsp;&nbsp;</td>
<td>Text to convert.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-04-09 17:29:09 +00:00
<hr />
<a name="methodUniArrSubString"></a>
2010-03-20 13:26:55 +00:00
<h3>method UniArrSubString <span class="smalllinenumber">[line 4669]</span></h3>
2009-04-09 17:29:09 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>Return UniArrSubString(
string
$uniarr, [int
$start = ''], [int
$end = ''])</code>
</td></tr></table>
</td></tr></table><br />
Extract a slice of the $uniarr array and return it as string.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>part of a string</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.037 (2009-04-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$uniarr</b>&nbsp;&nbsp;</td>
<td>The input array of characters.</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$start</b>&nbsp;&nbsp;</td>
<td>the starting element of $strarr.</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$end</b>&nbsp;&nbsp;</td>
<td>first element that will not be returned.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="methodunichr"></a>
2010-03-20 13:26:55 +00:00
<h3>method unichr <span class="smalllinenumber">[line 4702]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>Returns unichr(
int
$c)</code>
</td></tr></table>
</td></tr></table><br />
Returns the unicode caracter specified by UTF-8 code<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>the specified character.</td>
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Miguel Perez, Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.3.000 (2008-03-05)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$c</b>&nbsp;&nbsp;</td>
<td>UTF-8 code</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-04-09 17:29:09 +00:00
<hr />
<a name="methodUTF8ArrayToUniArray"></a>
2010-03-20 13:26:55 +00:00
<h3>method UTF8ArrayToUniArray <span class="smalllinenumber">[line 4690]</span></h3>
2009-04-09 17:29:09 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>Return UTF8ArrayToUniArray(
string
$ta)</code>
</td></tr></table>
</td></tr></table><br />
Convert an array of UTF8 values to array of unicode characters<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>array of unicode characters</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.037 (2009-04-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$ta</b>&nbsp;&nbsp;</td>
<td>The input array of UTF8 values.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="methodUTF8ArrSubString"></a>
2010-03-20 13:26:55 +00:00
<h3>method UTF8ArrSubString <span class="smalllinenumber">[line 4646]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>Return UTF8ArrSubString(
string
$strarr, [int
$start = ''], [int
$end = ''])</code>
</td></tr></table>
</td></tr></table><br />
Extract a slice of the $strarr array and return it as string.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>part of a string</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$strarr</b>&nbsp;&nbsp;</td>
<td>The input array of characters.</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$start</b>&nbsp;&nbsp;</td>
<td>the starting element of $strarr.</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$end</b>&nbsp;&nbsp;</td>
<td>first element that will not be returned.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2010-01-15 11:32:16 +00:00
<hr />
<a name="methodUTF8ArrToLatin1"></a>
2010-03-20 13:26:55 +00:00
<h3>method UTF8ArrToLatin1 <span class="smalllinenumber">[line 7743]</span></h3>
2010-01-15 11:32:16 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array UTF8ArrToLatin1(
array
$unicode)</code>
</td></tr></table>
</td></tr></table><br />
Converts UTF-8 characters array to Latin1<br /><br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.023 (2010-01-15)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$unicode</b>&nbsp;&nbsp;</td>
<td>array containing UTF-8 unicode values</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="methodutf8Bidi"></a>
2010-03-20 13:26:55 +00:00
<h3>method utf8Bidi <span class="smalllinenumber">[line 9471]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string utf8Bidi(
array
2009-04-09 17:29:09 +00:00
$ta, [string
$str = ''], [bool
2009-03-24 18:37:18 +00:00
$forcertl = false])</code>
</td></tr></table>
</td></tr></table><br />
Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.4.000 (2008-03-06)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$ta</b>&nbsp;&nbsp;</td>
<td>array of characters composing the string.</td>
2009-04-09 17:29:09 +00:00
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$str</b>&nbsp;&nbsp;</td>
<td>string to process</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
<td class="type">bool&nbsp;&nbsp;</td>
<td><b>$forcertl</b>&nbsp;&nbsp;</td>
<td>if 'R' forces RTL, if 'L' forces LTR</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodUTF8StringToArray"></a>
2010-03-20 13:26:55 +00:00
<h3>method UTF8StringToArray <span class="smalllinenumber">[line 7606]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array UTF8StringToArray(
string
$str)</code>
</td></tr></table>
</td></tr></table><br />
Converts UTF-8 strings to codepoints array.<br /><br /><br /><p>Invalid byte sequences will be replaced with 0xFFFD (replacement character)<br /> Based on: http://www.faqs.org/rfcs/rfc3629.html <pre> Char. number range | UTF-8 octet sequence
(hexadecimal) | (binary)
--------------------+-----------------------------------------------
0000 0000-0000 007F | 0xxxxxxx
0000 0080-0000 07FF | 110xxxxx 10xxxxxx
0000 0800-0000 FFFF | 1110xxxx 10xxxxxx 10xxxxxx
0001 0000-0010 FFFF | 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
---------------------------------------------------------------------
ABFN notation:
---------------------------------------------------------------------
UTF8-octets = *( UTF8-char )
UTF8-char = UTF8-1 / UTF8-2 / UTF8-3 / UTF8-4
UTF8-1 = %x00-7F
UTF8-2 = %xC2-DF UTF8-tail
UTF8-3 = %xE0 %xA0-BF UTF8-tail / %xE1-EC 2( UTF8-tail ) /
%xED %x80-9F UTF8-tail / %xEE-EF 2( UTF8-tail )
UTF8-4 = %xF0 %x90-BF 2( UTF8-tail ) / %xF1-F3 3( UTF8-tail ) /
%xF4 %x80-8F 2( UTF8-tail )
UTF8-tail = %x80-BF
---------------------------------------------------------------------</pre></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>containing codepoints (UTF-8 characters values)</td>
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.53.0.TC005 (2005-01-05)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$str</b>&nbsp;&nbsp;</td>
<td>string to process.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodutf8StrRev"></a>
2010-03-20 13:26:55 +00:00
<h3>method utf8StrRev <span class="smalllinenumber">[line 9457]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string utf8StrRev(
string
$str, [
$setbom = false], [bool
$forcertl = false])</code>
</td></tr></table>
</td></tr></table><br />
Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-08)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$str</b>&nbsp;&nbsp;</td>
<td>string to manipulate.</td>
</tr>
<tr>
<td class="type">bool&nbsp;&nbsp;</td>
<td><b>$forcertl</b>&nbsp;&nbsp;</td>
<td>if 'R' forces RTL, if 'L' forces LTR</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$setbom</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodUTF8ToLatin1"></a>
2010-03-20 13:26:55 +00:00
<h3>method UTF8ToLatin1 <span class="smalllinenumber">[line 7713]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string UTF8ToLatin1(
string
$str)</code>
</td></tr></table>
</td></tr></table><br />
Converts UTF-8 strings to Latin1 when using the standard 14 core fonts.<br /><br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Andrew Whitehead, Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.2.000 (2008-06-23)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$str</b>&nbsp;&nbsp;</td>
<td>string to process.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodUTF8ToUTF16BE"></a>
2010-03-20 13:26:55 +00:00
<h3>method UTF8ToUTF16BE <span class="smalllinenumber">[line 7697]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string UTF8ToUTF16BE(
string
$str, [boolean
$setbom = true])</code>
</td></tr></table>
</td></tr></table><br />
Converts UTF-8 strings to UTF16-BE.<br /><br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.53.0.TC005 (2005-01-05)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
<tr>
<td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodUTF8StringToArray">TCPDF::UTF8StringToArray()</a>, - arrUTF8ToUTF16BE()</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$str</b>&nbsp;&nbsp;</td>
<td>string to process.</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$setbom</b>&nbsp;&nbsp;</td>
<td>if true set the Byte Order Mark (BOM = 0xFEFF)</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodWrite"></a>
2010-03-20 13:26:55 +00:00
<h3>method Write <span class="smalllinenumber">[line 4290]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>mixed Write(
float
$h, string
$txt, [mixed
$link = ''], [int
$fill = 0], [string
$align = ''], [boolean
$ln = false], [int
$stretch = 0], [boolean
$firstline = false], [boolean
$firstblock = false], [float
$maxh = 0])</code>
</td></tr></table>
</td></tr></table><br />
This method prints text from the current position.<br /><br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>Return the number of cells or the remaining string if $firstline = true.</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.5</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>Line height</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$txt</b>&nbsp;&nbsp;</td>
<td>String to print</td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$link</b>&nbsp;&nbsp;</td>
<td>URL or identifier returned by AddLink()</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$fill</b>&nbsp;&nbsp;</td>
<td>Indicates if the background must be painted (1) or transparent (0). Default value: 0.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$align</b>&nbsp;&nbsp;</td>
<td>Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul></td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$ln</b>&nbsp;&nbsp;</td>
<td>if true set cursor at the bottom of the line, otherwise set cursor at the top of the line.</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$stretch</b>&nbsp;&nbsp;</td>
<td>stretch carachter mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if necessary</li><li>4 = forced character spacing</li></ul></td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$firstline</b>&nbsp;&nbsp;</td>
<td>if true prints only the first line and return the remaining string.</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$firstblock</b>&nbsp;&nbsp;</td>
<td>if true the string is the starting of a line.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$maxh</b>&nbsp;&nbsp;</td>
<td>maximum height. The remaining unprinted text will be returned. It should be &gt;= $h and less then remaining space to the bottom of the page, or 0 for disable this feature.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodwrite1DBarcode"></a>
2010-03-20 13:26:55 +00:00
<h3>method write1DBarcode <span class="smalllinenumber">[line 12296]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void write1DBarcode(
string
$code, string
$type, [int
$x = ''], [int
$y = ''], [int
$w = ''], [int
$h = ''], [float
$xres = 0.4], [array
$style = ''], [string
$align = ''])</code>
</td></tr></table>
</td></tr></table><br />
2009-04-11 17:02:39 +00:00
Print a Linear Barcode.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-06-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$code</b>&nbsp;&nbsp;</td>
<td>code to print</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$type</b>&nbsp;&nbsp;</td>
<td>type of barcode.</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>x position in user units</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>y position in user units</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>width in user units</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
2009-04-09 17:29:09 +00:00
<td>height in user units</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$xres</b>&nbsp;&nbsp;</td>
<td>width of the smallest bar in user units</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>array of options:<ul><li>string $style['position'] barcode position inside the specified width: L = left (default for LTR); C = center; R = right (default for RTL); S = stretch</li><li>boolean $style['border'] if true prints a border around the barcode</li><li>int $style['padding'] padding to leave around the barcode in user units</li><li>array $style['fgcolor'] color array for bars and text</li><li>mixed $style['bgcolor'] color array for background or false for transparent</li><li>boolean $style[&quot;text&quot;] boolean if true prints text below the barcode</li><li>string $style['font'] font name for text</li><li>int $style['fontsize'] font size for text</li><li>int $style['stretchtext']: 0 = disabled; 1 = horizontal scaling only if necessary; 2 = forced horizontal scaling; 3 = character spacing only if necessary; 4 = forced character spacing</li></ul></td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$align</b>&nbsp;&nbsp;</td>
2009-04-09 17:29:09 +00:00
<td>Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodwrite2DBarcode"></a>
2010-03-20 13:26:55 +00:00
<h3>method write2DBarcode <span class="smalllinenumber">[line 12553]</span></h3>
2009-04-09 17:29:09 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void write2DBarcode(
string
$code, string
$type, [int
$x = ''], [int
$y = ''], [int
$w = ''], [int
$h = ''], [array
$style = ''], [string
$align = ''])</code>
</td></tr></table>
</td></tr></table><br />
Print 2D Barcode.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.037 (2009-04-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$code</b>&nbsp;&nbsp;</td>
<td>code to print</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$type</b>&nbsp;&nbsp;</td>
<td>type of barcode.</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>x position in user units</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>y position in user units</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>width in user units</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>height in user units</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>array of options:<ul><li>boolean $style['border'] if true prints a border around the barcode</li><li>int $style['padding'] padding to leave around the barcode in user units</li><li>array $style['fgcolor'] color array for bars and text</li><li>mixed $style['bgcolor'] color array for background or false for transparent</li></ul></td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$align</b>&nbsp;&nbsp;</td>
<td>Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul></td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodwriteBarcode"></a>
2010-03-20 13:26:55 +00:00
<h3>method writeBarcode <span class="smalllinenumber">[line 12503]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void writeBarcode(
int
$x, int
$y, int
$w, int
$h, string
$type, string
$style, string
$font, int
$xres, string
$code)</code>
</td></tr></table>
</td></tr></table><br />
This function is DEPRECATED, please use the new write1DBarcode() function.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodwrite1DBarcode">TCPDF::write1DBarcode()</a></td>
</tr>
<tr>
<td><b>deprecated:</b>&nbsp;&nbsp;</td><td>deprecated since version 3.1.000 (2008-06-10)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>x position in user units</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>y position in user units</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>width in user units</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>height position in user units</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$type</b>&nbsp;&nbsp;</td>
<td>type of barcode (I25, C128A, C128B, C128C, C39)</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>barcode style</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$font</b>&nbsp;&nbsp;</td>
<td>font for text</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$xres</b>&nbsp;&nbsp;</td>
<td>x resolution</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$code</b>&nbsp;&nbsp;</td>
<td>code to print</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodwriteDiskCache"></a>
2010-03-20 13:26:55 +00:00
<h3>method writeDiskCache <span class="smalllinenumber">[line 15814]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void writeDiskCache(
$filename, mixed
$data, [boolean
$append = false], string
$file)</code>
</td></tr></table>
</td></tr></table><br />
Writes data to a temporary file on filesystem.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.000 (2008-12-31)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$file</b>&nbsp;&nbsp;</td>
<td>file name</td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$data</b>&nbsp;&nbsp;</td>
<td>data to write on file</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$append</b>&nbsp;&nbsp;</td>
<td>if true append data, false replace.</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$filename</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodwriteHTML"></a>
2010-03-20 13:26:55 +00:00
<h3>method writeHTML <span class="smalllinenumber">[line 13301]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void writeHTML(
string
$html, [boolean
$ln = true], [int
$fill = false], [boolean
$reseth = false], [boolean
$cell = false], [string
$align = ''])</code>
</td></tr></table>
</td></tr></table><br />
2009-05-28 17:14:22 +00:00
Allows to preserve some HTML formatting (limited support).<br /> IMPORTANT: The HTML must be well formatted - try to clean-up it using an application like HTML-Tidy before submitting.<br /><br /><p>Supported tags are: a, b, blockquote, br, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, img, li, ol, p, pre, small, span, strong, sub, sup, table, tcpdf, td, th, thead, tr, tt, u, ul</p><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$html</b>&nbsp;&nbsp;</td>
<td>text to display</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$ln</b>&nbsp;&nbsp;</td>
<td>if true add a new line after text (default = true)</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$fill</b>&nbsp;&nbsp;</td>
<td>Indicates if the background must be painted (true) or transparent (false).</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$reseth</b>&nbsp;&nbsp;</td>
<td>if true reset the last cell height (default false).</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$cell</b>&nbsp;&nbsp;</td>
<td>if true add the default cMargin space to each Write (default false).</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$align</b>&nbsp;&nbsp;</td>
<td>Allows to center or align the text. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodwriteHTMLCell"></a>
2010-03-20 13:26:55 +00:00
<h3>method writeHTMLCell <span class="smalllinenumber">[line 12797]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void writeHTMLCell(
float
$w, float
$h, float
$x, float
$y, [string
$html = ''], [mixed
$border = 0], [int
$ln = 0], [int
$fill = 0], [boolean
$reseth = true], [string
$align = ''], [boolean
$autopadding = true])</code>
</td></tr></table>
</td></tr></table><br />
Prints a cell (rectangular area) with optional borders, background color and html text string.<br /><br /><p>The upper-left corner of the cell corresponds to the current position. After the call, the current position moves to the right or to the next line.<br /> If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td>Multicell(), <a href="../com-tecnick-tcpdf/TCPDF.html#methodwriteHTML">TCPDF::writeHTML()</a></td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
<tr>
<td><b>uses:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodMultiCell">TCPDF::MultiCell()</a></td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>Cell width. If 0, the cell extends up to the right margin.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>Cell minimum height. The cell extends automatically if needed.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>upper-left corner X coordinate</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>upper-left corner Y coordinate</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$html</b>&nbsp;&nbsp;</td>
<td>html text to print. Default value: empty string.</td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$border</b>&nbsp;&nbsp;</td>
<td>Indicates if borders must be drawn around the cell. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul></td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$ln</b>&nbsp;&nbsp;</td>
<td>Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL language)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul></td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$fill</b>&nbsp;&nbsp;</td>
<td>Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$reseth</b>&nbsp;&nbsp;</td>
<td>if true reset the last cell height (default true).</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$align</b>&nbsp;&nbsp;</td>
<td>Allows to center or align the text. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul></td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$autopadding</b>&nbsp;&nbsp;</td>
<td>if true, uses internal padding and automatically adjust it to account for line width.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_addfield"></a>
2010-03-20 13:26:55 +00:00
<h3>method _addfield <span class="smalllinenumber">[line 10252]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _addfield(
2010-01-14 14:02:19 +00:00
string
$type, string
$name, int
$x, int
$y, int
$w, int
$h, array
2009-03-24 18:37:18 +00:00
$prop)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Adds a javascript form field.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Denis Van Nuffelen, Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.002 (2008-02-12)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$type</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>field type</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$name</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>field name</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$x</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>horizontal position</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$y</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>vertical position</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$w</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>width</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">int&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$h</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>height</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">array&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$prop</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>javascript field properties. Possible values are described on official Javascript for Acrobat API reference.</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_beginpage"></a>
2010-03-20 13:26:55 +00:00
<h3>method _beginpage <span class="smalllinenumber">[line 7336]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _beginpage(
[string
$orientation = ''], [mixed
$format = ''])</code>
</td></tr></table>
</td></tr></table><br />
Initialize a new page.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$orientation</b>&nbsp;&nbsp;</td>
<td>page orientation. Possible values are (case insensitive):<ul><li>P or PORTRAIT (default)</li><li>L or LANDSCAPE</li></ul></td>
</tr>
<tr>
<td class="type">mixed&nbsp;&nbsp;</td>
<td><b>$format</b>&nbsp;&nbsp;</td>
<td>The format used for pages. It can be either one of the following values (case insensitive) or a custom format in the form of a two-element array containing the width and the height (expressed in the unit given by unit).<ul><li>4A0</li><li>2A0</li><li>A0</li><li>A1</li><li>A2</li><li>A3</li><li>A4 (default)</li><li>A5</li><li>A6</li><li>A7</li><li>A8</li><li>A9</li><li>A10</li><li>B0</li><li>B1</li><li>B2</li><li>B3</li><li>B4</li><li>B5</li><li>B6</li><li>B7</li><li>B8</li><li>B9</li><li>B10</li><li>C0</li><li>C1</li><li>C2</li><li>C3</li><li>C4</li><li>C5</li><li>C6</li><li>C7</li><li>C8</li><li>C9</li><li>C10</li><li>RA0</li><li>RA1</li><li>RA2</li><li>RA3</li><li>RA4</li><li>SRA0</li><li>SRA1</li><li>SRA2</li><li>SRA3</li><li>SRA4</li><li>LETTER</li><li>LEGAL</li><li>EXECUTIVE</li><li>FOLIO</li></ul></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2010-02-12 16:46:01 +00:00
<hr />
<a name="method_dataannobjstring"></a>
2010-03-20 13:26:55 +00:00
<h3>method _dataannobjstring <span class="smalllinenumber">[line 7485]</span></h3>
2010-02-12 16:46:01 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string _dataannobjstring(
string
$s)</code>
</td></tr></table>
</td></tr></table><br />
Format a data string for annotation objects<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>escaped string.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$s</b>&nbsp;&nbsp;</td>
<td>data string to escape.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="method_datastring"></a>
2010-03-20 13:26:55 +00:00
<h3>method _datastring <span class="smalllinenumber">[line 7472]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string _datastring(
string
$s)</code>
</td></tr></table>
</td></tr></table><br />
2009-08-25 18:07:52 +00:00
Format a data string for meta information<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>escaped string.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$s</b>&nbsp;&nbsp;</td>
2010-02-12 16:46:01 +00:00
<td>data string to escape.</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-08-25 18:07:52 +00:00
<hr />
<a name="method_datestring"></a>
2010-03-20 13:26:55 +00:00
<h3>method _datestring <span class="smalllinenumber">[line 7498]</span></h3>
2009-08-25 18:07:52 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string _datestring(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns a formatted date for meta information<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>escaped date string.</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.6.028 (2009-08-25)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="method_destroy"></a>
2010-03-20 13:26:55 +00:00
<h3>method _destroy <span class="smalllinenumber">[line 5579]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _destroy(
[boolean
$destroyall = false], [boolean
$preserve_objcopy = false])</code>
</td></tr></table>
</td></tr></table><br />
Unset all class variables except the following critical variables: internal_encoding, state, bufferlen, buffer and diskcache.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.5.016 (2009-02-24)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$destroyall</b>&nbsp;&nbsp;</td>
<td>if true destroys all class variables, otherwise preserves critical variables.</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$preserve_objcopy</b>&nbsp;&nbsp;</td>
<td>if true preserves the objcopy variable</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_dochecks"></a>
2010-03-20 13:26:55 +00:00
<h3>method _dochecks <span class="smalllinenumber">[line 5607]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _dochecks(
)</code>
</td></tr></table>
</td></tr></table><br />
Check for locale-related bug<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_dolinethrough"></a>
2010-03-20 13:26:55 +00:00
<h3>method _dolinethrough <span class="smalllinenumber">[line 7411]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _dolinethrough(
int
$x, int
$y, string
$txt)</code>
</td></tr></table>
</td></tr></table><br />
Line through text.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>X coordinate</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>Y coordinate</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$txt</b>&nbsp;&nbsp;</td>
<td>text to linethrough</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-09-29 11:19:41 +00:00
<hr />
<a name="method_dolinethroughw"></a>
2010-03-20 13:26:55 +00:00
<h3>method _dolinethroughw <span class="smalllinenumber">[line 7438]</span></h3>
2009-09-29 11:19:41 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _dolinethroughw(
int
$x, int
$y,
$w, string
$txt)</code>
</td></tr></table>
</td></tr></table><br />
Line through for rectangular text area.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.008 (2009-09-29)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>X coordinate</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>Y coordinate</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$txt</b>&nbsp;&nbsp;</td>
<td>text to linethrough</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="method_dounderline"></a>
2010-03-20 13:26:55 +00:00
<h3>method _dounderline <span class="smalllinenumber">[line 7399]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _dounderline(
int
$x, int
$y, string
$txt)</code>
</td></tr></table>
</td></tr></table><br />
Underline text.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>X coordinate</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>Y coordinate</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$txt</b>&nbsp;&nbsp;</td>
<td>text to underline</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-09-29 11:19:41 +00:00
<hr />
<a name="method_dounderlinew"></a>
2010-03-20 13:26:55 +00:00
<h3>method _dounderlinew <span class="smalllinenumber">[line 7424]</span></h3>
2009-09-29 11:19:41 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _dounderlinew(
int
$x, int
$y, int
$w)</code>
</td></tr></table>
</td></tr></table><br />
Underline for rectangular text area.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.008 (2009-09-29)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>X coordinate</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>Y coordinate</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>width to underline</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="method_enddoc"></a>
2010-03-20 13:26:55 +00:00
<h3>method _enddoc <span class="smalllinenumber">[line 7219]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _enddoc(
)</code>
</td></tr></table>
</td></tr></table><br />
Output end of document (EOF).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_endpage"></a>
2010-03-20 13:26:55 +00:00
<h3>method _endpage <span class="smalllinenumber">[line 7375]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _endpage(
)</code>
</td></tr></table>
</td></tr></table><br />
Mark end of page.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_escape"></a>
2010-03-20 13:26:55 +00:00
<h3>method _escape <span class="smalllinenumber">[line 7461]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string _escape(
string
$s)</code>
</td></tr></table>
</td></tr></table><br />
Add &quot;\&quot; before &quot;\&quot;, &quot;(&quot; and &quot;)&quot;<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>escaped string.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$s</b>&nbsp;&nbsp;</td>
<td>string to escape.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_escapetext"></a>
2010-03-20 13:26:55 +00:00
<h3>method _escapetext <span class="smalllinenumber">[line 7523]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string _escapetext(
string
$s)</code>
</td></tr></table>
</td></tr></table><br />
Format a text string<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>escaped string.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$s</b>&nbsp;&nbsp;</td>
<td>string to escape.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_freadint"></a>
2010-03-20 13:26:55 +00:00
<h3>method _freadint <span class="smalllinenumber">[line 7450]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>4-byte _freadint(
string
$f)</code>
</td></tr></table>
</td></tr></table><br />
Read a 4-byte integer from file.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>integer</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$f</b>&nbsp;&nbsp;</td>
<td>file name.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_generateencryptionkey"></a>
2010-03-20 13:26:55 +00:00
<h3>method _generateencryptionkey <span class="smalllinenumber">[line 8126]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _generateencryptionkey(
String
$user_pass, String
$owner_pass, String
$protection)</code>
</td></tr></table>
</td></tr></table><br />
Compute encryption key<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Klemen Vodopivec</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000 (2008-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">String&nbsp;&nbsp;</td>
<td><b>$user_pass</b>&nbsp;&nbsp;</td>
<td>user password</td>
</tr>
<tr>
<td class="type">String&nbsp;&nbsp;</td>
<td><b>$owner_pass</b>&nbsp;&nbsp;</td>
<td>user password</td>
</tr>
<tr>
<td class="type">String&nbsp;&nbsp;</td>
<td><b>$protection</b>&nbsp;&nbsp;</td>
<td>protection type</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_getfontpath"></a>
2010-03-20 13:26:55 +00:00
<h3>method _getfontpath <span class="smalllinenumber">[line 5623]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string _getfontpath(
)</code>
</td></tr></table>
</td></tr></table><br />
Return fonts path<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_JScolor"></a>
2010-03-20 13:26:55 +00:00
<h3>method _JScolor <span class="smalllinenumber">[line 10228]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _JScolor(
2010-01-14 14:02:19 +00:00
string
2009-03-24 18:37:18 +00:00
$color)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Convert color to javascript color.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Denis Van Nuffelen, Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.002 (2008-02-12)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">string&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$color</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>color name or #RRGGBB</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_md5_16"></a>
2010-03-20 13:26:55 +00:00
<h3>method _md5_16 <span class="smalllinenumber">[line 8087]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>String _md5_16(
string
$str)</code>
</td></tr></table>
</td></tr></table><br />
Encrypts a string using MD5 and returns it's value as a binary string.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>MD5 encrypted binary string</td>
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Klemen Vodopivec</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000 (2008-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$str</b>&nbsp;&nbsp;</td>
<td>input string</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_newobj"></a>
2010-03-20 13:26:55 +00:00
<h3>method _newobj <span class="smalllinenumber">[line 7385]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
2009-07-23 23:08:13 +00:00
<code>int _newobj(
2009-03-24 18:37:18 +00:00
)</code>
</td></tr></table>
</td></tr></table><br />
2009-07-23 23:08:13 +00:00
Begin a new object and return the object number.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2009-07-23 23:08:13 +00:00
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>object number</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_objectkey"></a>
2010-03-20 13:26:55 +00:00
<h3>method _objectkey <span class="smalllinenumber">[line 8019]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _objectkey(
int
$n)</code>
</td></tr></table>
</td></tr></table><br />
Compute encryption key depending on object number where the encrypted data is stored<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000 (2008-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$n</b>&nbsp;&nbsp;</td>
<td>object number</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_out"></a>
2010-03-20 13:26:55 +00:00
<h3>method _out <span class="smalllinenumber">[line 7554]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _out(
string
$s)</code>
</td></tr></table>
</td></tr></table><br />
Output a string to the document.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$s</b>&nbsp;&nbsp;</td>
<td>string to output.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_outarc"></a>
2010-03-20 13:26:55 +00:00
<h3>method _outarc <span class="smalllinenumber">[line 11889]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _outarc(
$x1,
$y1,
$x2,
$y2,
$x3,
$y3)</code>
</td></tr></table>
</td></tr></table><br />
Output an arc<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Maxime Delorme, Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-06-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$x1</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$y1</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$x2</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$y2</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$x3</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$y3</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_outCurve"></a>
2010-03-20 13:26:55 +00:00
<h3>method _outCurve <span class="smalllinenumber">[line 8654]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _outCurve(
2010-01-14 14:02:19 +00:00
float
$x1, float
$y1, float
$x2, float
$y2, float
$x3, float
2009-03-24 18:37:18 +00:00
$y3)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Draws a Bezier curve from last draw point.<br /><br /><p>The Bezier curve is a tangent to the line between the control points at either end of the curve.</p><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-08)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$x1</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Abscissa of control point 1.</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$y1</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Ordinate of control point 1.</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$x2</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Abscissa of control point 2.</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$y2</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Ordinate of control point 2.</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$x3</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Abscissa of end point.</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$y3</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Ordinate of end point.</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_outLine"></a>
2010-03-20 13:26:55 +00:00
<h3>method _outLine <span class="smalllinenumber">[line 8618]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _outLine(
2010-01-14 14:02:19 +00:00
float
$x, float
2009-03-24 18:37:18 +00:00
$y)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Draws a line from last draw point.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-08)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$x</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Abscissa of end point.</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$y</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Ordinate of end point.</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_outPoint"></a>
2010-03-20 13:26:55 +00:00
<h3>method _outPoint <span class="smalllinenumber">[line 8604]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _outPoint(
2010-01-14 14:02:19 +00:00
float
$x, float
2009-03-24 18:37:18 +00:00
$y)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Set a draw point.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-08)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$x</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Abscissa of point.</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
2010-01-14 14:02:19 +00:00
<td class="type">float&nbsp;&nbsp;</td>
2009-03-24 18:37:18 +00:00
<td><b>$y</b>&nbsp;&nbsp;</td>
2010-01-14 14:02:19 +00:00
<td>Ordinate of point.</td>
2009-03-24 18:37:18 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_outRect"></a>
2010-03-20 13:26:55 +00:00
<h3>method _outRect <span class="smalllinenumber">[line 8635]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _outRect(
float
$x, float
$y, float
$w, float
$h, string
$op)</code>
</td></tr></table>
</td></tr></table><br />
Draws a rectangle.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.000 (2008-01-08)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$x</b>&nbsp;&nbsp;</td>
<td>Abscissa of upper-left corner (or upper-right corner for RTL language).</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$y</b>&nbsp;&nbsp;</td>
<td>Ordinate of upper-left corner (or upper-right corner for RTL language).</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>Width.</td>
</tr>
<tr>
<td class="type">float&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>Height.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$op</b>&nbsp;&nbsp;</td>
<td>options</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_Ovalue"></a>
2010-03-20 13:26:55 +00:00
<h3>method _Ovalue <span class="smalllinenumber">[line 8100]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>String _Ovalue(
String
$user_pass, String
$owner_pass)</code>
</td></tr></table>
</td></tr></table><br />
Compute O value (used for RC4 encryption)<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>O value</td>
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Klemen Vodopivec</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000 (2008-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">String&nbsp;&nbsp;</td>
<td><b>$user_pass</b>&nbsp;&nbsp;</td>
<td>user password</td>
</tr>
<tr>
<td class="type">String&nbsp;&nbsp;</td>
<td><b>$owner_pass</b>&nbsp;&nbsp;</td>
<td>user password</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_parsejpeg"></a>
2010-03-20 13:26:55 +00:00
<h3>method _parsejpeg <span class="smalllinenumber">[line 5058]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array _parsejpeg(
string
$file)</code>
</td></tr></table>
</td></tr></table><br />
Extract info from a JPEG file without using the GD library.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>structure containing the image data</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$file</b>&nbsp;&nbsp;</td>
<td>image file to parse</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_parsepng"></a>
2010-03-20 13:26:55 +00:00
<h3>method _parsepng <span class="smalllinenumber">[line 5084]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array _parsepng(
string
$file)</code>
</td></tr></table>
</td></tr></table><br />
Extract info from a PNG file without using the GD library.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>structure containing the image data</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$file</b>&nbsp;&nbsp;</td>
<td>image file to parse</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
2009-08-29 16:09:18 +00:00
<a name="method_putannotsobjs"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putannotsobjs <span class="smalllinenumber">[line 5806]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
2009-08-29 16:09:18 +00:00
<code>void _putannotsobjs(
)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Output annotations objects for all pages.<br /><br /><p>!!! THIS METHOD IS NOT YET COMPLETED !!! See section 12.5 of PDF 32000_2008 reference.</p><br /><br /><br />
2009-08-29 16:09:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.018 (2008-08-06)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putannotsrefs"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putannotsrefs <span class="smalllinenumber">[line 5775]</span></h3>
2009-08-29 16:09:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putannotsrefs(
2009-03-24 18:37:18 +00:00
int
$n)</code>
</td></tr></table>
</td></tr></table><br />
2009-08-29 16:09:18 +00:00
Output referencees to page annotations<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
2009-08-29 16:09:18 +00:00
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.7.000 (2008-08-29)</td>
2009-03-24 18:37:18 +00:00
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$n</b>&nbsp;&nbsp;</td>
<td>page number</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-09-09 21:21:25 +00:00
<hr />
<a name="method_putAPXObject"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putAPXObject <span class="smalllinenumber">[line 6421]</span></h3>
2009-09-09 21:21:25 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>int _putAPXObject(
[int
$w = 0], [int
$h = 0], [string
$stream = ''])</code>
</td></tr></table>
</td></tr></table><br />
Put appearance streams XObject used to define annotation's appearance states<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>object ID</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.8.001 (2009-09-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$w</b>&nbsp;&nbsp;</td>
<td>annotation width</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$h</b>&nbsp;&nbsp;</td>
<td>annotation height</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$stream</b>&nbsp;&nbsp;</td>
<td>appearance stream</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
2009-03-24 18:37:18 +00:00
<hr />
<a name="method_putbookmarks"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putbookmarks <span class="smalllinenumber">[line 10070]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putbookmarks(
)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Create a bookmark PDF string.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Olivier Plathey, Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.002 (2008-02-12)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putcatalog"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putcatalog <span class="smalllinenumber">[line 7044]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putcatalog(
)</code>
</td></tr></table>
</td></tr></table><br />
Output Catalog.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putcidfont0"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putcidfont0 <span class="smalllinenumber">[line 6778]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
2009-09-09 21:21:25 +00:00
<code>int _putcidfont0(
2009-03-24 18:37:18 +00:00
array
$font)</code>
</td></tr></table>
</td></tr></table><br />
2009-08-24 15:52:35 +00:00
Output CID-0 fonts.<br /><br /><p>A Type 0 CIDFont contains glyph descriptions based on the Adobe Type 1 font format</p><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2009-09-09 21:21:25 +00:00
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>font object ID</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Andrew Whitehead, Nicola Asuni, Yukihiro Nakadaira</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.2.000 (2008-06-23)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$font</b>&nbsp;&nbsp;</td>
<td>font data</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putEmbeddedFiles"></a>
2010-03-13 19:49:15 +00:00
<h3>method _putEmbeddedFiles <span class="smalllinenumber">[line 3573]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putEmbeddedFiles(
)</code>
</td></tr></table>
</td></tr></table><br />
Embedd the attached files.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../com-tecnick-tcpdf/TCPDF.html#methodAnnotation">TCPDF::Annotation()</a></td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.4.000 (2008-12-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putencryption"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putencryption <span class="smalllinenumber">[line 8028]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putencryption(
)</code>
</td></tr></table>
</td></tr></table><br />
Put encryption on PDF document.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000 (2008-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putextgstates"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putextgstates <span class="smalllinenumber">[line 11565]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putextgstates(
2010-01-14 14:02:19 +00:00
array
$gs)</code>
2009-03-24 18:37:18 +00:00
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Put extgstates for object transparency<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
2010-01-14 14:02:19 +00:00
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$gs</b>&nbsp;&nbsp;</td>
<td>extgstate</td>
</tr>
</table>
</div><br />
2009-03-24 18:37:18 +00:00
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putfonts"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putfonts <span class="smalllinenumber">[line 6449]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putfonts(
)</code>
</td></tr></table>
</td></tr></table><br />
Output fonts.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putfontwidths"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putfontwidths <span class="smalllinenumber">[line 6587]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putfontwidths(
array
$font, [int
$cidoffset = 0])</code>
</td></tr></table>
</td></tr></table><br />
Outputs font widths<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.4.000 (2008-12-07)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$font</b>&nbsp;&nbsp;</td>
<td>font data</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$cidoffset</b>&nbsp;&nbsp;</td>
<td>offset for CID values</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putheader"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putheader <span class="smalllinenumber">[line 7211]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putheader(
)</code>
</td></tr></table>
</td></tr></table><br />
Output PDF header.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putimages"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putimages <span class="smalllinenumber">[line 6846]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putimages(
)</code>
</td></tr></table>
</td></tr></table><br />
Output images.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putinfo"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putinfo <span class="smalllinenumber">[line 7004]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putinfo(
)</code>
</td></tr></table>
</td></tr></table><br />
2009-11-21 10:45:13 +00:00
Adds some Metadata information (Document Information Dictionary)<br /><br /><p>(see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference)</p><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putjavascript"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putjavascript <span class="smalllinenumber">[line 10168]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putjavascript(
)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Create a javascript PDF string.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Johannes G<>ntert, Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.1.002 (2008-02-12)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putocg"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putocg <span class="smalllinenumber">[line 11479]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putocg(
)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Put visibility settings.<br /><br /><br /><br />
2009-03-24 18:37:18 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.0.000 (2008-03-27)</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putpages"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putpages <span class="smalllinenumber">[line 5634]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putpages(
)</code>
</td></tr></table>
</td></tr></table><br />
Output pages.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putresourcedict"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putresourcedict <span class="smalllinenumber">[line 6929]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putresourcedict(
)</code>
</td></tr></table>
</td></tr></table><br />
Output Resources Dictionary.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putresources"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putresources <span class="smalllinenumber">[line 6970]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putresources(
)</code>
</td></tr></table>
</td></tr></table><br />
Output Resources.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putshaders"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putshaders <span class="smalllinenumber">[line 11839]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putshaders(
)</code>
</td></tr></table>
</td></tr></table><br />
Output shaders.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Andreas W<>rmser, Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-06-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
2009-07-23 23:08:13 +00:00
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putsignature"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putsignature <span class="smalllinenumber">[line 11200]</span></h3>
2009-07-23 23:08:13 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putsignature(
)</code>
</td></tr></table>
</td></tr></table><br />
2010-01-14 14:02:19 +00:00
Add certification signature (DocMDP or UR3)<br /><br /><p>You can set only one signature type</p><br /><br /><br />
2009-07-23 23:08:13 +00:00
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2010-01-14 14:02:19 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.6.008 (2009-05-07)</td>
</tr>
2009-07-23 23:08:13 +00:00
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
2009-03-24 18:37:18 +00:00
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putspotcolors"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putspotcolors <span class="smalllinenumber">[line 6901]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putspotcolors(
)</code>
</td></tr></table>
</td></tr></table><br />
Output Spot Colors Resources.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>4.0.024 (2008-09-12)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putstream"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putstream <span class="smalllinenumber">[line 7540]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putstream(
string
$s)</code>
</td></tr></table>
</td></tr></table><br />
Output a stream.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$s</b>&nbsp;&nbsp;</td>
<td>string to output.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_puttrailer"></a>
2010-03-20 13:26:55 +00:00
<h3>method _puttrailer <span class="smalllinenumber">[line 7197]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _puttrailer(
)</code>
</td></tr></table>
</td></tr></table><br />
Output trailer.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_puttruetypeunicode"></a>
2010-03-20 13:26:55 +00:00
<h3>method _puttruetypeunicode <span class="smalllinenumber">[line 6686]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
2009-09-09 21:21:25 +00:00
<code>int _puttruetypeunicode(
2009-03-24 18:37:18 +00:00
array
$font)</code>
</td></tr></table>
</td></tr></table><br />
Adds unicode fonts.<br /><br /><br /><p>Based on PDF Reference 1.3 (section 5)</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
2009-09-09 21:21:25 +00:00
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>font object ID</td>
</tr>
2009-03-24 18:37:18 +00:00
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola Asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>1.52.0.TC005 (2005-01-05)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$font</b>&nbsp;&nbsp;</td>
<td>font data</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putviewerpreferences"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putviewerpreferences <span class="smalllinenumber">[line 7127]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putviewerpreferences(
)</code>
</td></tr></table>
</td></tr></table><br />
Output viewer preferences.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Nicola asuni</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>3.1.000 (2008-06-09)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_putxobjectdict"></a>
2010-03-20 13:26:55 +00:00
<h3>method _putxobjectdict <span class="smalllinenumber">[line 6918]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _putxobjectdict(
)</code>
</td></tr></table>
</td></tr></table><br />
Output object dictionary for images.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_RC4"></a>
2010-03-20 13:26:55 +00:00
<h3>method _RC4 <span class="smalllinenumber">[line 8047]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>String _RC4(
string
$key, String
$text)</code>
</td></tr></table>
</td></tr></table><br />
Returns the input text exrypted using RC4 algorithm and the specified key.<br /><br /><p>RC4 is the standard encryption algorithm used in PDF format</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>encrypted text</td>
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Klemen Vodopivec</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000 (2008-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$key</b>&nbsp;&nbsp;</td>
<td>encryption key</td>
</tr>
<tr>
<td class="type">String&nbsp;&nbsp;</td>
<td><b>$text</b>&nbsp;&nbsp;</td>
<td>input text to be encrypted</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_textstring"></a>
2010-03-20 13:26:55 +00:00
<h3>method _textstring <span class="smalllinenumber">[line 7509]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string _textstring(
string
$s)</code>
</td></tr></table>
</td></tr></table><br />
Format a text string for meta information<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>escaped string.</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$s</b>&nbsp;&nbsp;</td>
<td>string to escape.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_toJPEG"></a>
2010-03-20 13:26:55 +00:00
<h3>method _toJPEG <span class="smalllinenumber">[line 5042]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _toJPEG(
image
$image, string
$file)</code>
</td></tr></table>
</td></tr></table><br />
Convert the loaded php image to a JPEG and then return a structure for the PDF creator.<br /><br /><p>This function requires GD library and write access to the directory defined on K_PATH_CACHE constant.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$file</b>&nbsp;&nbsp;</td>
<td>Image file name.</td>
</tr>
<tr>
<td class="type">image&nbsp;&nbsp;</td>
<td><b>$image</b>&nbsp;&nbsp;</td>
<td>Image object. return image JPEG image object.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_Uvalue"></a>
2010-03-20 13:26:55 +00:00
<h3>method _Uvalue <span class="smalllinenumber">[line 8113]</span></h3>
2009-03-24 18:37:18 +00:00
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>String _Uvalue(
)</code>
</td></tr></table>
</td></tr></table><br />
Compute U value (used for RC4 encryption)<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>U value</td>
</tr>
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Klemen Vodopivec</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>2.0.000 (2008-01-02)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
</div><br />
<div class="credit">
<hr />
2010-03-20 13:26:55 +00:00
Documentation generated on Sat, 20 Mar 2010 14:26:42 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a>
2009-03-24 18:37:18 +00:00
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>