Docs For Class TCPDF

## Class TCPDF

Description

This is a PHP5 class for generating PDF files on-the-fly without requiring external extensions.

This class is an extension and improvement of the FPDF class by Olivier Plathey (http://www.fpdf.org).
This version contains some changes: [porting to PHP5, support for UTF-8 Unicode, code style and formatting, php documentation (www.phpdoc.org), ISO page formats, minor improvements, image scale factor]
TCPDF project (http://tcpdf.sourceforge.net) is based on the Public Domain FPDF class by Olivier Plathey (http://www.fpdf.org).
To add your own TTF fonts please read /fonts/README.TXT

- license: LGPL
- link: http://tcpdf.sourceforge.net
- author: Nicola Asuni
- version: 1.53.0.TC031
- name: TCPDF

Located in /tcpdf.php (line 87)

Variable Summary
alias $AliasNbPages
author $author
automatic $AutoPageBreak
Bold $b
Barcode $barcode
page $bMargin
buffer $buffer
cell $cMargin
indicates $ColorFlag
compression $compress
array $CoreFonts
creator $creator
current $CurOrientation
current $CurrentFont
Default $default_table_columns
default $DefOrientation
array $diffs
commands $DrawColor
default $encoding
height $fh
height $fhPt
commands $FillColor
current $FontFamily
array $FontFiles
HTML $fontList
array $fonts
current $FontSize
current $FontSizePt
current $FontStyle
Footer $footer_font
Minimum $footer_margin
width $fw
width $fwPt
current $h
Header $header_font
Header $header_logo
Header $header_logo_width
Minimum $header_margin
String $header_string
String $header_title
Header $header_width
current $hPt
HTML $HREF
Italic $i
array $images
image $imgscale
right-bottom $img_rb_x
right-bottom $img_rb_y
flag $InFooter
PHP $internal_encoding
HTML $issetcolor
HTML $issetfont
boolean $isunicode
scale $k
keywords $keywords
Language $l
height $lasth
layout $LayoutMode
line $LineWidth
array $links
spacer $lispacer
HTML $listcount
HTML $listordered
left $lMargin
current $n
array $offsets
array $OrientationChanges
original $original_lMargin
original $original_rMargin
current $page
threshold $PageBreakTrigger
array $PageLinks
array $pages
PDF $PDFVersion
store $prevFillColor
store $prevFontFamily
store $prevFontStyle
store $prevTextColor
If $print_footer
If $print_header
right $rMargin
current $state
subject $subject
HTML $tableborder
HTML $tdalign
HTML $tdbegin
HTML $tdbgcolor
HTML $tdheight
HTML $tdwidth
Store $tempfontsize
commands $TextColor
title $title
top $tMargin
Underlined $u
underlining $underline
current $w
current $wPt
word $ws
current $x
current $y
zoom $ZoomMode
Method Summary
TCPDF __construct ([string $orientation = 'P'], [string $unit = 'mm'], [mixed $format = 'A4'], [boolean $unicode = true], [String $encoding = "UTF-8"])
void __destruct ()
boolean AcceptPageBreak ()
void AddFont (string $family, [string $style = ''], [string $file = ''])
void addHtmlLink (string $url, string $name, int $fill)
void AddLink ()
void AddPage ([string $orientation = ''])
void AliasNbPages ([string $alias = '{nb}'])
void Cell (float $w, float $h, [string $txt = ''], mixed $border, int $ln, [string $align = ''], int $fill, [mixed $link = ''])
void Close ()
void closedHTMLTagHandler (string $tag)
array convertColorHexToDec ([string $color = "#000000"])
void Error (string $msg)
void Footer ()
int getBreakMargin ()
float getImageScale ()
int getPageHeight ()
int getPageWidth ()
void getPDFData ()
int getScaleFactor ()
int GetStringWidth (string $s)
float GetX ()
float GetY ()
void Header ()
void Image (string $file, float $x, float $y, float $w, float $h, [string $type = ''], [mixed $link = ''])
void Line (float $x1, float $y1, float $x2, float $y2)
void Link (float $x, float $y, float $w, float $h, mixed $link)
void Ln ([float $h = ''])
void MultiCell (float $w, float $h, string $txt, mixed $border, [string $align = 'J'], int $fill, [int $ln = 1])
void Open ()
void openHTMLTagHandler (string $tag, string $attr, int $fill)
void Output ([string $name = ''], [string $dest = ''])
int PageNo ()
float pixelsToMillimeters (int $px)
void Rect (float $x, float $y, float $w, float $h, [string $style = ''])
void SetAuthor (string $author)
void SetAutoPageBreak (boolean $auto, float $margin)
void setBarcode ([string $bc = ""])
void SetCompression (boolean $compress)
void SetCreator (string $creator)
void SetDisplayMode (mixed $zoom, [string $layout = 'continuous'])
void SetDrawColor (int $r, [int $g = -1], [int $b = -1])
void SetFillColor (int $r, [int $g = -1], [int $b = -1], [boolean $storeprev = false])
void SetFont (string $family, [string $style = ''], float $size)
void SetFontSize (float $size)
void setFooterFont (array $font)
void setFooterMargin ([int $fm = 10])
void setHeaderData ([string $ln = ""], string $lw, [string $ht = ""], [string $hs = ""])
void setHeaderFont (array $font)
void setHeaderMargin ([int $hm = 10])
void setImageScale (float $scale)
void SetKeywords (string $keywords)
void setLanguageArray (array $language)
void SetLeftMargin (float $margin)
void SetLineWidth (float $width)
void SetLink (int $link, float $y, [int $page = -1])
void SetMargins (float $left, float $top, [float $right = -1])
void setPrintFooter ([mixed $val = true], boolean $value)
void setPrintHeader ([boolean $val = true])
void SetRightMargin (float $margin)
void setStyle (string $tag, boolean $enable)
void SetSubject (string $subject)
void SetTextColor (int $r, [int $g = -1], [int $b = -1], [boolean $storeprev = false])
void SetTitle (string $title)
void SetTopMargin (float $margin)
void SetX (float $x)
void SetXY (float $x, float $y)
void SetY (float $y)
void Text (float $x, float $y, string $txt)
string unhtmlentities ($text_to_convert $text_to_convert)
array UTF8StringToArray (string $str)
string UTF8ToUTF16BE (string $str, [boolean $setbom = true])
void Write (float $h, string $txt, [mixed $link = ''], int $fill)
void writeBarcode (int $x, int $y, int $w, int $h, string $type, string $style, string $font, int $xres, string $code)
void writeHTML (string $html, [boolean $ln = true], int $fill)
void writeHTMLCell (float $w, float $h, float $x, float $y, [string $html = ''], mixed $border, int $ln, int $fill)
void _begindoc ()
void _beginpage (mixed $orientation)
void _dochecks ()
void _dounderline (mixed $x, mixed $y, mixed $txt)
void _enddoc ()
void _endpage ()
void _escape (mixed $s)
void _escapetext (mixed $s)
void _freadint (mixed $f)
void _getfontpath ()
void _newobj ()
void _out (mixed $s)
void _parsejpg (mixed $file)
void _parsepng (mixed $file)
void _putcatalog ()
void _putfonts ()
void _putheader ()
void _putimages ()
void _putinfo ()
void _putpages ()
void _putresourcedict ()
void _putresources ()
void _putstream (mixed $s)
void _puttrailer ()
void _puttruetypeunicode (mixed $font)
void _putxobjectdict ()
void _textstring (mixed $s)
Variables
alias $AliasNbPages (line 430)

- var: for total number of pages
- access: protected

author $author (line 412)

- access: protected

automatic $AutoPageBreak (line 370)

- var: page breaking
- access: protected

Bold $b (line 657)

- var: font style status.
- access: private

Barcode $barcode = false (line 522)

- var: to print on page footer (only if set).
- access: private

page $bMargin (line 226)

- var: break margin
- access: protected

buffer $buffer (line 112)

- var: holding in-memory PDF
- access: protected

cell $cMargin (line 232)

- var: margin
- access: protected

indicates $ColorFlag (line 358)

- var: whether fill and text colors are different
- access: protected

compression $compress (line 130)

- var: flag
- access: protected

array $CoreFonts (line 262)

- var: of standard font names
- access: protected

creator $creator (line 424)

- access: protected

current $CurOrientation (line 142)

- var: orientation
- access: protected

current $CurrentFont (line 322)

- var: font info
- access: protected

Default $default_table_columns = 4 (line 570)

- var: number of columns for html table.
- access: private

default $DefOrientation (line 136)

- var: orientation
- access: protected

array $diffs (line 280)

- var: of encoding differences
- access: protected

commands $DrawColor (line 340)

- var: for drawing color
- access: protected

default $encoding = "UTF-8" (line 682)

- var: encoding
- access: private
- since: 1.53.0.TC010

height $fh (line 178)

- var: of page format in user unit
- access: protected

height $fhPt (line 166)

- var: of page format in points
- access: protected

commands $FillColor (line 346)

- var: for filling color
- access: protected

current $FontFamily (line 304)

- var: font family
- access: protected

array $FontFiles (line 274)

- var: of font files
- access: protected

HTML $fontList (line 585)

- var: PARSER: store font list.
- access: private

array $fonts (line 268)

- var: of used fonts
- access: protected

current $FontSize (line 334)

- var: font size in user unit
- access: protected

current $FontSizePt (line 328)

- var: font size in points
- access: protected

current $FontStyle (line 310)

- var: font style
- access: protected

Footer $footer_font (line 510)

- var: font.
- access: private

Minimum $footer_margin (line 484)

- var: distance between footer and bottom page margin.
- access: private

width $fw (line 172)

- var: of page format in user unit
- access: protected

width $fwPt (line 160)

- var: of page format in points
- access: protected

current $h (line 202)

- var: height of page in user unit
- access: protected

Header $header_font (line 504)

- var: font.
- access: private

Header $header_logo = "" (line 546)

- var: image logo.
- access: private

Header $header_logo_width = 30 (line 552)

- var: image logo width in mm.
- access: private

Minimum $header_margin (line 478)

- var: distance between header and top page margin.
- access: private

String $header_string = "" (line 564)

- var: to print on document header.
- access: private

String $header_title = "" (line 558)

- var: to print as title on document header.
- access: private

Header $header_width = 0 (line 540)

- var: width (0 = full page width).
- access: private

current $hPt (line 190)

- var: height of page in points
- access: protected

HTML $HREF (line 579)

- var: PARSER: store current link.
- access: private

Italic $i (line 669)

- var: font style status.
- access: private

array $images (line 286)

- var: of used images
- access: protected

image $imgscale = 1 (line 454)

- var: scale factor
- access: protected
- author: Nicola Asuni
- since: 2004-06-14

right-bottom $img_rb_x (line 438)

- var: corner X coordinate of inserted image
- access: protected
- author: Nicola Asuni
- since: 2002-07-31

right-bottom $img_rb_y (line 446)

- var: corner Y coordinate of inserted image
- access: protected
- author: Nicola Asuni
- since: 2002-07-31

flag $InFooter (line 382)

- var: set when processing footer
- access: protected

PHP $internal_encoding (line 689)

- var: internal encoding
- access: private
- since: 1.53.0.TC016

HTML $issetcolor (line 597)

- var: PARSER: true when color attribute is set.
- access: private

HTML $issetfont (line 591)

- var: PARSER: true when font attribute is set.
- access: private

boolean $isunicode = false (line 462)

- var: set to true when the input text is unicode (require unicode fonts)
- access: protected
- author: Nicola Asuni
- since: 2005-01-02

scale $k (line 154)

- var: factor (number of points in user unit)
- access: protected

keywords $keywords (line 418)

- access: protected

Language $l (line 516)

- var: templates.
- access: private

height $lasth (line 250)

- var: of last cell printed
- access: protected

layout $LayoutMode (line 394)

- var: display mode
- access: protected

line $LineWidth (line 256)

- var: width in user unit
- access: protected

array $links (line 298)

- var: of internal links
- access: protected

spacer $lispacer = "" (line 675)

- var: for LI tags.
- access: private

HTML $listcount = 0 (line 609)

- var: PARSER: count list items.
- access: private

HTML $listordered = false (line 603)

- var: PARSER: true in case of ordered list (OL), false otherwise.
- access: private

left $lMargin (line 208)

- var: margin
- access: protected

current $n (line 100)

- var: object number
- access: protected

array $offsets (line 106)

- var: of object offsets
- access: protected

array $OrientationChanges (line 148)

- var: indicating orientation changes
- access: protected

original $original_lMargin (line 491)

- var: left margin value
- access: private
- since: 1.53.0.TC013

original $original_rMargin (line 498)

- var: right margin value
- access: private
- since: 1.53.0.TC013

current $page (line 94)

- var: page number
- access: protected

threshold $PageBreakTrigger (line 376)

- var: used to trigger page breaks
- access: protected

array $PageLinks (line 292)

- var: of links in pages
- access: protected

array $pages (line 118)

- var: containing pages
- access: protected

PDF $PDFVersion = "1.3" (line 469)

- var: version
- access: protected
- since: 1.5.3

store $prevFillColor = array(255,255,255) (line 696)

- var: previous fill color as RGB array
- access: private
- since: 1.53.0.TC017

store $prevFontFamily (line 710)

- var: previous font family
- access: private
- since: 1.53.0.TC017

store $prevFontStyle (line 717)

- var: previous font style
- access: private
- since: 1.53.0.TC017

store $prevTextColor = array(0,0,0) (line 703)

- var: previous text color as RGB array
- access: private
- since: 1.53.0.TC017

If $print_footer = true (line 534)

- var: true prints footer.
- access: private

If $print_header = true (line 528)

- var: true prints header
- access: private

right $rMargin (line 220)

- var: margin
- access: protected

current $state (line 124)

- var: document state
- access: protected

subject $subject (line 406)

- access: protected

HTML $tableborder = 0 (line 615)

- var: PARSER: size of table border.
- access: private

HTML $tdalign = "L" (line 639)

- var: PARSER: table align.
- access: private

HTML $tdbegin = false (line 621)

- var: PARSER: true at the beginning of table.
- access: private

HTML $tdbgcolor = false (line 645)

- var: PARSER: table background color.
- access: private

HTML $tdheight = 0 (line 633)

- var: PARSER: table height.
- access: private

HTML $tdwidth = 0 (line 627)

- var: PARSER: table width.
- access: private

Store $tempfontsize = 10 (line 651)

- var: temporary font size in points.
- access: private

commands $TextColor (line 352)

- var: for text color
- access: protected

title $title (line 400)

- access: protected

top $tMargin (line 214)

- var: margin
- access: protected

Underlined $u (line 663)

- var: font style status.
- access: private

underlining $underline (line 316)

- var: flag
- access: protected

current $w (line 196)

- var: width of page in user unit
- access: protected

current $wPt (line 184)

- var: width of page in points
- access: protected

word $ws (line 364)

- var: spacing
- access: protected

current $x (line 238)

- var: horizontal position in user unit for cell positioning
- access: protected

current $y (line 244)

- var: vertical position in user unit for cell positioning
- access: protected

zoom $ZoomMode (line 388)

- var: display mode
- access: protected

Methods
Constructor __construct (line 735)

This is the class constructor.

It allows to set up the page format, the orientation and the measure unit used in all the methods (except for the font sizes).

- access: public
- since: 1.0

TCPDF __construct ([string $orientation = 'P'], [string $unit = 'mm'], [mixed $format = 'A4'], [boolean $unicode = true], [String $encoding = "UTF-8"])

- string $orientation: page orientation. Possible values are (case insensitive):
  - P or Portrait (default)
  - L or Landscape
- string $unit: User measure unit. Possible values are:
  - pt: point
  - mm: millimeter (default)
  - cm: centimeter
  - in: inch
  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.
- mixed $format: 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).
  - 4A0
  - 2A0
  - A0
  - A1
  - A2
  - A3
  - A4 (default)
  - A5
  - A6
  - A7
  - A8
  - A9
  - A10
  - B0
  - B1
  - B2
  - B3
  - B4
  - B5
  - B6
  - B7
  - B8
  - B9
  - B10
  - C0
  - C1
  - C2
  - C3
  - C4
  - C5
  - C6
  - C7
  - C8
  - C9
  - C10
  - RA0
  - RA1
  - RA2
  - RA3
  - RA4
  - SRA0
  - SRA1
  - SRA2
  - SRA3
  - SRA4
  - LETTER
  - LEGAL
  - EXECUTIVE
  - FOLIO
- boolean $unicode: TRUE means that the input text is unicode (default = true)
- String $encoding: charset encoding; default is UTF-8

Destructor __destruct (line 921)

Default destructor.

- access: public
- since: 1.53.0.TC016

void __destruct ()
AcceptPageBreak (line 1949)

Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value. The default implementation returns a value according to the mode selected by SetAutoPageBreak().

This method is called automatically and should not be called directly by the application.
Example:
The method is overriden in an inherited class in order to obtain a 3 column layout:

     class PDF extends TCPDF {
     	var $col=0;

     	public function SetCol($col) {
     		//Move position to a column
     		$this->col=$col;
     		$x=10+$col*65;
     		$this->SetLeftMargin($x);
     		$this->SetX($x);
     	}

     	public function AcceptPageBreak() {
     		if($this->col<2) {
     			//Go to next column
     			$this->SetCol($this->col+1);
     			$this->SetY(10);
     			return false;
     		}
     		else {
     			//Go back to first column and issue page break
     			$this->SetCol(0);
     			return true;
     		}
     	}
     }

     $pdf=new PDF();
     $pdf->Open();
     $pdf->AddPage();
     $pdf->SetFont('Arial','',12);
     for($i=1;$i<=300;$i++) {
         $pdf->Cell(0,5,"Line $i",0,1);
     }
     $pdf->Output();

- access: public
- see: TCPDF::SetAutoPageBreak()
- since: 1.4

boolean AcceptPageBreak ()
AddFont (line 1627)

Imports a TrueType or Type1 font and makes it available. It is necessary to generate a font definition file first with the makefont.php utility. The definition file (and the font file itself when embedding) must be present either in the current directory or in the one indicated by FPDF_FONTPATH if the constant is defined. If it could not be found, the error "Could not include font definition file" is generated.

Support UTF-8 Unicode [Nicola Asuni, 2005-01-02]. Example:

     $pdf->AddFont('Comic','I');
     // is equivalent to:
     $pdf->AddFont('Comic','I','comici.php');

- access: public
- see: TCPDF::SetFont()
- since: 1.5

void AddFont (string $family, [string $style = ''], [string $file = ''])

- string $family: Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.
- string $style: Font style. Possible values are (case insensitive):
  - empty string: regular (default)
  - B: bold
  - I: italic
  - BI or IB: bold italic
- string $file: The font definition file. By default, the name is built from the family and style, in lower case with no space.

addHtmlLink (line 4150)

Output anchor link.

- access: public

void addHtmlLink (string $url, string $name, int $fill)

- string $url: link URL
- string $name: link name
- int $fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.

AddLink (line 1843)

Creates a new internal link and returns its identifier. An internal link is a clickable area which directs to another place within the document.
The identifier can then be passed to Cell(), Write(), Image() or Link(). The destination is defined with SetLink().

- access: public
- see: TCPDF::Cell(), TCPDF::Write(), TCPDF::Image(), TCPDF::Link(), TCPDF::SetLink()
- since: 1.5

void AddLink ()
AddPage (line 1228)

Adds a new page to the document. If a page is already present, the Footer() method is called first to output the footer. Then the page is added, the current position set to the top-left corner according to the left and top margins, and Header() is called to display the header.

The font which was set before calling is automatically restored. There is no need to call SetFont() again if you want to continue with the same font. The same is true for colors and line width. The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.

- access: public
- see: TCPDF(), TCPDF::Header(), TCPDF::Footer(), TCPDF::SetMargins()
- since: 1.0

void AddPage ([string $orientation = ''])

- string $orientation: Page orientation. Possible values are (case insensitive):
  - P or Portrait
  - L or Landscape
  The default value is the one passed to the constructor.

AliasNbPages (line 1170)

Defines an alias for the total number of pages. It will be substituted as the document is closed.

Example:

     class PDF extends TCPDF {
     	public function Footer() {
     		//Go to 1.5 cm from bottom
     		$this->SetY(-15);
     		//Select Arial italic 8
     		$this->SetFont('Arial','I',8);
     		//Print current and total page numbers
     		$this->Cell(0,10,'Page '.$this->PageNo().'/{nb}',0,0,'C');
     	}
     }
     $pdf=new PDF();
     $pdf->AliasNbPages();

- access: public
- see: TCPDF::PageNo(), TCPDF::Footer()
- since: 1.4

void AliasNbPages ([string $alias = '{nb}'])

- string $alias: The alias. Default value: {nb}.

Cell (line 1969)

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.
If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.

- access: public
- see: TCPDF::SetFont(), TCPDF::SetDrawColor(), TCPDF::SetFillColor(), TCPDF::SetTextColor(), TCPDF::SetLineWidth(), TCPDF::AddLink(), TCPDF::Ln(), TCPDF::MultiCell(), TCPDF::Write(), TCPDF::SetAutoPageBreak()
- since: 1.0

void Cell (float $w, float $h, [string $txt = ''], mixed $border, int $ln, [string $align = ''], int $fill, [mixed $link = ''])

- float $w: Cell width. If 0, the cell extends up to the right margin.
- float $h: Cell height. Default value: 0.
- string $txt: String to print. Default value: empty string.
- mixed $border: Indicates if borders must be drawn around the cell. The value can be either a number:
  - 0: no border (default)
  - 1: frame
  or a string containing some or all of the following characters (in any order):
  - L: left
  - T: top
  - R: right
  - B: bottom
- int $ln: Indicates where the current position should go after the call. Possible values are:
  - 0: to the right
  - 1: to the beginning of the next line
  - 2: below
- string $align: Allows to center or align the text. Possible values are:
  - L or empty string: left align (default value)
  - C: center
  - R: right align
- int $fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
- mixed $link: URL or identifier returned by AddLink().

Close (line 1202)

Terminates the PDF document. 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.

- access: public
- see: TCPDF::Open(), TCPDF::Output()
- since: 1.0

void Close ()
closedHTMLTagHandler (line 4016)

Process closing tags.

- access: private

void closedHTMLTagHandler (string $tag)

- string $tag: tag name (in uppercase)

convertColorHexToDec (line 4166)

Returns an associative array (keys: R,G,B) from a hex html code (e.g. #3FE5AA).

- access: private

array convertColorHexToDec ([string $color = "#000000"])

- string $color: hexadecimal html color [#rrggbb]

Error (line 1181)

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.

2004-06-11 :: Nicola Asuni : changed bold tag with strong

- access: public
- since: 1.0

void Error (string $msg)

- string $msg: The error message

Footer (line 1400)

This method is used to render the page footer.

It is automatically called by AddPage() and could be overwritten in your own inherited class.

- access: public

void Footer ()
getBreakMargin (line 974)

Returns the page break margin.

- return: page break margin.
- access: public
- since: 1.5.2
- author: Nicola Asuni

int getBreakMargin ()
getImageScale (line 944)

Returns the image scale.

- return: image scale.
- access: public
- since: 1.5.2
- author: Nicola Asuni

float getImageScale ()
getPageHeight (line 964)

Returns the page height in units.

- return: page height.
- access: public
- since: 1.5.2
- author: Nicola Asuni

int getPageHeight ()
getPageWidth (line 954)

Returns the page width in units.

- return: page width.
- access: public
- since: 1.5.2
- author: Nicola Asuni

int getPageWidth ()
getPDFData (line 3648)

Returns the PDF data.

- access: public

void getPDFData ()
getScaleFactor (line 984)

Returns the scale factor (number of points in user unit).

- return: scale factor.
- access: public
- since: 1.5.2
- author: Nicola Asuni

int getScaleFactor ()
GetStringWidth (line 1527)

Returns the length of a string in user unit. A font must be selected.

Support UTF-8 Unicode [Nicola Asuni, 2005-01-02]

- access: public
- since: 1.2

int GetStringWidth (string $s)

- string $s: The string whose length is to be computed

GetX (line 2409)

Returns the abscissa of the current position.

- access: public
- see: TCPDF::SetX(), TCPDF::GetY(), TCPDF::SetY()
- since: 1.2

float GetX ()
GetY (line 2436)

Returns the ordinate of the current position.

- access: public
- see: TCPDF::SetY(), TCPDF::GetX(), TCPDF::SetX()
- since: 1.0

float GetY ()
Header (line 1347)

This method is used to render the page header.

It is automatically called by AddPage() and could be overwritten in your own inherited class.

- access: public

void Header ()
Image (line 2327)

Puts an image in the page. The upper-left corner must be given. The dimensions can be specified in different ways:

- explicit width and height (expressed in user unit)
- one explicit dimension, the other being calculated automatically in order to keep the original proportions
- no explicit dimension, in which case the image is put at 72 dpi

Supported formats are JPEG and PNG.

For JPEG, all flavors are allowed:

- gray scales
- true colors (24 bits)
- CMYK (32 bits)

For PNG, are allowed:

- gray scales on at most 8 bits (256 levels)
- indexed colors
- true colors (24 bits)

but are not supported:

- Interlacing
- Alpha channel

If a transparent color is defined, it will be taken into account (but will be only interpreted by Acrobat 4 and above).
The format can be specified explicitly or inferred from the file extension.
It is possible to put a link on the image.
Remark: if an image is used several times, only one copy will be embedded in the file.

- access: public
- see: TCPDF::AddLink()
- since: 1.1

void Image (string $file, float $x, float $y, float $w, float $h, [string $type = ''], [mixed $link = ''])

- string $file: Name of the file containing the image.
- float $x: Abscissa of the upper-left corner.
- float $y: Ordinate of the upper-left corner.
- float $w: Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
- float $h: Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
- string $type: Image format. Possible values are (case insensitive): JPG, JPEG, PNG. If not specified, the type is inferred from the file extension.
- mixed $link: URL or identifier returned by AddLink().

Line (line 1583)

Draws a line between two points.

- access: public
- see: TCPDF::SetLineWidth(), TCPDF::SetDrawColor()
- since: 1.0

void Line (float $x1, float $y1, float $x2, float $y2)

- float $x1: Abscissa of first point
- float $y1: Ordinate of first point
- float $x2: Abscissa of second point
- float $y2: Ordinate of second point

Link (line 1879)

Puts a link on a rectangular area of the page. 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.

- access: public
- see: TCPDF::AddLink(), TCPDF::Cell(), TCPDF::Write(), TCPDF::Image()
- since: 1.5

void Link (float $x, float $y, float $w, float $h, mixed $link)

- float $x: Abscissa of the upper-left corner of the rectangle
- float $y: Ordinate of the upper-left corner of the rectangle
- float $w: Width of the rectangle
- float $h: Height of the rectangle
- mixed $link: URL or identifier returned by AddLink()

Ln (line 2392)

Performs a line break. The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.

- access: public
- see: TCPDF::Cell()
- since: 1.0

void Ln ([float $h = ''])

- float $h: The height of the break. By default, the value equals the height of the last printed cell.

MultiCell (line 2071)

This method allows printing text with line breaks. 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.
Text can be aligned, centered or justified. The cell block can be framed and the background painted.

- access: public
- see: TCPDF::SetFont(), TCPDF::SetDrawColor(), TCPDF::SetFillColor(), TCPDF::SetTextColor(), TCPDF::SetLineWidth(), TCPDF::Cell(), TCPDF::Write(), TCPDF::SetAutoPageBreak()
- since: 1.3

void MultiCell (float $w, float $h, string $txt, mixed $border, [string $align = 'J'], int $fill, [int $ln = 1])

- float $w: Width of cells. If 0, they extend up to the right margin of the page.
- float $h: Height of cells.
- string $txt: String to print
- mixed $border: Indicates if borders must be drawn around the cell block. The value can be either a number:
  - 0: no border (default)
  - 1: frame
  or a string containing some or all of the following characters (in any order):
  - L: left
  - T: top
  - R: right
  - B: bottom
- string $align: Allows to center or align the text. Possible values are:
  - L or empty string: left align
  - C: center
  - R: right align
  - J: justification (default value)
- int $fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
- int $ln: Indicates where the current position should go after the call. Possible values are:
  - 0: to the right
  - 1: to the beginning of the next line [DEFAULT]
  - 2: below

Open (line 1192)

This method begins the generation of the PDF document. It is not necessary to call it explicitly because AddPage() does it automatically.

Note: no page is created by this method

- access: public
- see: TCPDF::AddPage(), TCPDF::Close()
- since: 1.0

void Open ()
openHTMLTagHandler (line 3811)

Process opening tags.

- access: private

void openHTMLTagHandler (string $tag, string $attr, int $fill)

- string $tag: tag name (in uppercase)
- string $attr: tag attribute (in uppercase)
- int $fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.

Output (line 2479)

Send the document to a given destination: string, local file or browser. In the last case, the plug-in may be used (if present) or a download ("Save as" dialog box) may be forced.
The method first calls Close() if necessary to terminate the document.

- access: public
- see: TCPDF::Close()
- since: 1.0

void Output ([string $name = ''], [string $dest = ''])

- string $name: The name of the file. If not given, the document will be sent to the browser (destination I) with the name doc.pdf.
- string $dest: Destination where to send the document. It can take one of the following values:
  - I: send the file inline to the browser. The plug-in is used if available. The name given by name is used when one selects the "Save as" option on the link generating the PDF.
  - D: send to the browser and force a file download with the name given by name.
  - F: save to a local file with the name given by name.
  - S: return the document as a string. name is ignored.
  If the parameter is not specified but a name is given, destination is F. If no parameter is specified at all, destination is I.
  Note: for compatibility with previous versions, a boolean value is also accepted (false for F and true for D).

PageNo (line 1443)

Returns the current page number.

- return: page number
- access: public
- see: TCPDF::AliasNbPages()
- since: 1.0

int PageNo ()
pixelsToMillimeters (line 4180)

Converts pixels to millimeters in 72 dpi.

- return: millimeters
- access: private

float pixelsToMillimeters (int $px)

- int $px: pixels

Rect (line 1598)

Outputs a rectangle. It can be drawn (border only), filled (with no border) or both.

- access: public
- see: TCPDF::SetLineWidth(), TCPDF::SetDrawColor(), TCPDF::SetFillColor()
- since: 1.0

void Rect (float $x, float $y, float $w, float $h, [string $style = ''])

- float $x: Abscissa of upper-left corner
- float $y: Ordinate of upper-left corner
- float $w: Width
- float $h: Height
- string $style: Style of rendering. Possible values are:
  - D or empty string: draw (default)
  - F: fill
  - DF or FD: draw and fill

SetAuthor (line 1122)

Defines the author of the document.

- access: public
- see: TCPDF::SetCreator(), TCPDF::SetKeywords(), TCPDF::SetSubject(), TCPDF::SetTitle()
- since: 1.2

void SetAuthor (string $author)

- string $author: The name of the author.

SetAutoPageBreak (line 1049)

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.

- access: public
- see: TCPDF::Cell(), TCPDF::MultiCell(), TCPDF::AcceptPageBreak()
- since: 1.0

void SetAutoPageBreak (boolean $auto, float $margin)

- boolean $auto: Boolean indicating if mode should be on or off.
- float $margin: Distance from the bottom of the page.

setBarcode (line 3565)

Set document barcode.

- access: public

void setBarcode ([string $bc = ""])

- string $bc: barcode

SetCompression (line 1084)

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.

Note: the Zlib extension is required for this feature. If not present, compression will be turned off.

- access: public
- since: 1.4

void SetCompression (boolean $compress)

- boolean $compress: Boolean indicating if compression must be enabled.

SetCreator (line 1144)

Defines the creator of the document. This is typically the name of the application that generates the PDF.

- access: public
- see: TCPDF::SetAuthor(), TCPDF::SetKeywords(), TCPDF::SetSubject(), TCPDF::SetTitle()
- since: 1.2

void SetCreator (string $creator)

- string $creator: The name of the creator.

SetDisplayMode (line 1062)

Defines the way the document is to be displayed by the viewer. The zoom level can be set: pages can be displayed entirely on screen, occupy the full width of the window, use real size, be scaled by a specific zooming factor or use viewer default (configured in the Preferences menu of Acrobat). The page layout can be specified too: single at once, continuous display, two columns or viewer default. By default, documents use the full width mode with continuous display.

- access: public
- since: 1.2

void SetDisplayMode (mixed $zoom, [string $layout = 'continuous'])

- mixed $zoom: The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use.
  - fullpage: displays the entire page on screen
  - fullwidth: uses maximum width of window
  - real: uses real size (equivalent to 100% zoom)
  - default: uses viewer default mode
- string $layout: The page layout. Possible values are:
  - single: displays one page at once
  - continuous: displays pages continuously (default)
  - two: displays two pages on two columns
  - default: uses viewer default mode

SetDrawColor (line 1456)

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.

- access: public
- see: TCPDF::SetFillColor(), TCPDF::SetTextColor(), TCPDF::Line(), TCPDF::Rect(), TCPDF::Cell(), TCPDF::MultiCell()
- since: 1.3

void SetDrawColor (int $r, [int $g = -1], [int $b = -1])

- int $r: If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255
- int $g: Green component (between 0 and 255)
- int $b: Blue component (between 0 and 255)

SetFillColor (line 1478)

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.

- access: public
- see: TCPDF::SetDrawColor(), TCPDF::SetTextColor(), TCPDF::Rect(), TCPDF::Cell(), TCPDF::MultiCell()
- since: 1.3

void SetFillColor (int $r, [int $g = -1], [int $b = -1], [boolean $storeprev = false])

- int $r: If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255
- int $g: Green component (between 0 and 255)
- int $b: Blue component (between 0 and 255)
- boolean $storeprev: if true stores the RGB array on $prevFillColor variable.

SetFont (line 1726)

Sets the font used to print character strings. It is mandatory to call this method at least once before printing text or the resulting document would not be valid.

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. Note: for the standard fonts, the font metric files must be accessible. There are three possibilities for this:

- They are in the current directory (the one where the running script lies)
- They are in one of the directories defined by the include_path parameter
- They are in the directory defined by the FPDF_FONTPATH constant

Example for the last case (note the trailing slash):

     define('FPDF_FONTPATH','/home/www/font/');
     require('tcpdf.php');

     //Times regular 12
     $pdf->SetFont('Times');
     //Arial bold 14
     $pdf->SetFont('Arial','B',14);
     //Removes bold
     $pdf->SetFont('');
     //Times bold, italic and underlined 14
     $pdf->SetFont('Times','BIU');

If the file corresponding to the requested font is not found, the error "Could not include font metric file" is generated.

- access: public
- see: TCPDF::AddFont(), TCPDF::SetFontSize(), TCPDF::Cell(), TCPDF::MultiCell(), TCPDF::Write()
- since: 1.0

void SetFont (string $family, [string $style = ''], float $size)

- string $family: Family font. It can be either a name defined by AddFont() or one of the standard families (case insensitive):
  - Courier (fixed-width)
  - Helvetica or Arial (synonymous; sans serif)
  - Times (serif)
  - Symbol (symbolic)
  - ZapfDingbats (symbolic)
  It is also possible to pass an empty string. In that case, the current family is retained.
- string $style: Font style. Possible values are (case insensitive):
  - empty string: regular
  - B: bold
  - I: italic
  - U: underline
  or any combination. The default value is regular. Bold and italic styles do not apply to Symbol and ZapfDingbats
- float $size: 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

SetFontSize (line 1825)

Defines the size of the current font.

- access: public
- see: TCPDF::SetFont()
- since: 1.0

void SetFontSize (float $size)

- float $size: The size (in points)

setFooterFont (line 3548)

Set footer font.

- access: public
- since: 1.1

void setFooterFont (array $font)

- array $font: font

setFooterMargin (line 1323)

Set footer margin.

(minimum distance between footer and bottom page margin)

- access: public

void setFooterMargin ([int $fm = 10])

- int $fm: distance in millimeters

setHeaderData (line 1302)

Set header data.

- access: public

void setHeaderData ([string $ln = ""], string $lw, [string $ht = ""], [string $hs = ""])

- string $ln: header image logo
- string $lw: header image logo width in mm
- string $ht: string to print as title on document header
- string $hs: string to print on document header

setHeaderFont (line 3539)

Set header font.

- access: public
- since: 1.1

void setHeaderFont (array $font)

- array $font: font

setHeaderMargin (line 1314)

Set header margin.

(minimum distance between header and top page margin)

- access: public

void setHeaderMargin ([int $hm = 10])

- int $hm: distance in millimeters

setImageScale (line 934)

Set the image scale.

- access: public
- since: 1.5.2
- author: Nicola Asuni

void setImageScale (float $scale)

- float $scale: image scale.

SetKeywords (line 1133)

Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.

- access: public
- see: TCPDF::SetAuthor(), TCPDF::SetCreator(), TCPDF::SetSubject(), TCPDF::SetTitle()
- since: 1.2

void SetKeywords (string $keywords)

- string $keywords: The list of keywords.

setLanguageArray (line 3557)

Set language array.

- access: public
- since: 1.1

void setLanguageArray (array $language)

- array $language

SetLeftMargin (line 1012)

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.

- access: public
- see: TCPDF::SetTopMargin(), TCPDF::SetRightMargin(), TCPDF::SetAutoPageBreak(), TCPDF::SetMargins()
- since: 1.4

void SetLeftMargin (float $margin)

- float $margin: The margin.

SetLineWidth (line 1566)

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.

- access: public
- see: TCPDF::Line(), TCPDF::Rect(), TCPDF::Cell(), TCPDF::MultiCell()
- since: 1.0

void SetLineWidth (float $width)

- float $width: The width.

SetLink (line 1858)

Defines the page and position a link points to

- access: public
- see: TCPDF::AddLink()
- since: 1.5

void SetLink (int $link, float $y, [int $page = -1])

- int $link: The link identifier returned by AddLink()
- float $y: Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page)
- int $page: Number of target page; -1 indicates the current page. This is the default value

SetMargins (line 996)

Defines the left, top and right margins. By default, they equal 1 cm. Call this method to change them.

- access: public
- see: TCPDF::SetLeftMargin(), TCPDF::SetTopMargin(), TCPDF::SetRightMargin(), TCPDF::SetAutoPageBreak()
- since: 1.0

void SetMargins (float $left, float $top, [float $right = -1])

- float $left: Left margin.
- float $top: Top margin.
- float $right: Right margin. Default value is the left one.

setPrintFooter (line 1339)

Set a flag to print page footer.

- access: public

void setPrintFooter ([mixed $val = true], boolean $value)

- boolean $value: set to true to print the page footer (default), false otherwise.

setPrintHeader (line 1331)

Set a flag to print page header.

- access: public

void setPrintHeader ([boolean $val = true])

- boolean $val: set to true to print the page header (default), false otherwise.

SetRightMargin (line 1037)

Defines the right margin. The method can be called before creating the first page.

- access: public
- see: TCPDF::SetLeftMargin(), TCPDF::SetTopMargin(), TCPDF::SetAutoPageBreak(), TCPDF::SetMargins()
- since: 1.5

void SetRightMargin (float $margin)

- float $margin: The margin.

setStyle (line 4131)

Sets font style.

- access: private

void setStyle (string $tag, boolean $enable)

- string $tag: tag name (in lowercase)
- boolean $enable

SetSubject (line 1111)

Defines the subject of the document.

- access: public
- see: TCPDF::SetAuthor(), TCPDF::SetCreator(), TCPDF::SetKeywords(), TCPDF::SetTitle()
- since: 1.2

void SetSubject (string $subject)

- string $subject: The subject.

SetTextColor (line 1505)

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.

- access: public
- see: TCPDF::SetDrawColor(), TCPDF::SetFillColor(), TCPDF::Text(), TCPDF::Cell(), TCPDF::MultiCell()
- since: 1.3

void SetTextColor (int $r, [int $g = -1], [int $b = -1], [boolean $storeprev = false])

- int $r: If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255
- int $g: Green component (between 0 and 255)
- int $b: Blue component (between 0 and 255)
- boolean $storeprev: if true stores the RGB array on $prevTextColor variable.

SetTitle (line 1100)

Defines the title of the document.

- access: public
- see: TCPDF::SetAuthor(), TCPDF::SetCreator(), TCPDF::SetKeywords(), TCPDF::SetSubject()
- since: 1.2

void SetTitle (string $title)

- string $title: The title.

SetTopMargin (line 1026)

Defines the top margin. The method can be called before creating the first page.

- access: public
- see: TCPDF::SetLeftMargin(), TCPDF::SetRightMargin(), TCPDF::SetAutoPageBreak(), TCPDF::SetMargins()
- since: 1.5

void SetTopMargin (float $margin)

- float $margin: The margin.

SetX (line 2420)

Defines the abscissa of the current position. If the passed value is negative, it is relative to the right of the page.

- access: public
- see: TCPDF::GetX(), TCPDF::GetY(), TCPDF::SetY(), TCPDF::SetXY()
- since: 1.2

void SetX (float $x)

- float $x: The value of the abscissa.

SetXY (line 2465)

Defines the abscissa and ordinate of the current position. If the passed values are negative, they are relative respectively to the right and bottom of the page.

- access: public
- see: TCPDF::SetX(), TCPDF::SetY()
- since: 1.2

void SetXY (float $x, float $y)

- float $x: The value of the abscissa
- float $y: The value of the ordinate

SetY (line 2447)

Moves the current abscissa back to the left margin and sets the ordinate. If the passed value is negative, it is relative to the bottom of the page.

- access: public
- see: TCPDF::GetX(), TCPDF::GetY(), TCPDF::SetY(), TCPDF::SetXY()
- since: 1.0

void SetY (float $y)

- float $y: The value of the ordinate.

Text (line 1892)

Prints a character string. The origin is on the left of the first charcter, on the baseline. This method allows to place a string precisely on the page, but it is usually easier to use Cell(), MultiCell() or Write() which are the standard methods to print text.

- access: public
- see: TCPDF::SetFont(), TCPDF::SetTextColor(), TCPDF::Cell(), TCPDF::MultiCell(), TCPDF::Write()
- since: 1.0

void Text (float $x, float $y, string $txt)

- float $x: Abscissa of the origin
- float $y: Ordinate of the origin
- string $txt: String to print

unhtmlentities (line 4191)

Reverse function for htmlentities.

Convert entities in UTF-8.

- return: converted
- access: public

string unhtmlentities ($text_to_convert $text_to_convert)

- $text_to_convert $text_to_convert: Text to convert.

UTF8StringToArray (line 3400)

Converts UTF-8 strings to codepoints array.

Invalid byte sequences will be replaced with 0xFFFD (replacement character)
Based on: http://www.faqs.org/rfcs/rfc3629.html

     	  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
       ---------------------------------------------------------------------

- return: containing codepoints (UTF-8 characters values)
- usedby: TCPDF::UTF8ToUTF16BE()
- access: protected
- since: 1.53.0.TC005 (2005-01-05)
- author: Nicola Asuni

array UTF8StringToArray (string $str)

- string $str: string to process.

UTF8ToUTF16BE (line 3502)

Converts UTF-8 strings to UTF16-BE.

Based on: http://www.faqs.org/rfcs/rfc2781.html

       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

- access: protected
- uses: TCPDF::UTF8StringToArray()
- since: 1.53.0.TC005 (2005-01-05)
- author: Nicola Asuni

string UTF8ToUTF16BE (string $str, [boolean $setbom = true])

- string $str: string to process.
- boolean $setbom: if true set the Byte Order Mark (BOM = 0xFEFF)

Write (line 2219)

This method prints text from the current position. When the right margin is reached (or the \n character is met) a line break occurs and text continues from the left margin. Upon method exit, the current position is left just at the end of the text. It is possible to put a link on the text.

Example:

     //Begin with regular font
     $pdf->SetFont('Arial','',14);
     $pdf->Write(5,'Visit ');
     //Then put a blue underlined link
     $pdf->SetTextColor(0,0,255);
     $pdf->SetFont('','U');
     $pdf->Write(5,'www.tecnick.com','http://www.tecnick.com');

- access: public
- see: TCPDF::SetFont(), TCPDF::SetTextColor(), TCPDF::AddLink(), TCPDF::MultiCell(), TCPDF::SetAutoPageBreak()
- since: 1.5

void Write (float $h, string $txt, [mixed $link = ''], int $fill)

- float $h: Line height
- string $txt: String to print
- mixed $link: URL or identifier returned by AddLink()
- int $fill: Indicates if the background must be painted (1) or transparent (0). Default value: 0.

writeBarcode (line 3581)

Print Barcode.

- access: public

void writeBarcode (int $x, int $y, int $w, int $h, string $type, string $style, string $font, int $xres, string $code)

- int $x: x position in user units
- int $y: y position in user units
- int $w: width in user units
- int $h: height position in user units
- string $type: type of barcode (I25, C128A, C128B, C128C, C39)
- string $style: barcode style
- string $font: font for text
- int $xres: x resolution
- string $code: code to print

writeHTML (line 3664)

Allows to preserve some HTML formatting.

Supports: h1, h2, h3, h4, h5, h6, b, u, i, a, img, p, br, strong, em, font, blockquote, li, ul, ol, hr, td, th, tr, table, sup, sub, small

- access: public

void writeHTML (string $html, [boolean $ln = true], int $fill)

- string $html: text to display
- boolean $ln: if true add a new line after text (default = true)
- int $fill: Indicates if the background must be painted (1) or transparent (0). Default value: 0.

writeHTMLCell (line 3736)

Prints a cell (rectangular area) with optional borders, background color and html text string. 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.
If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.

- access: public
- see: TCPDF::Cell()

void writeHTMLCell (float $w, float $h, float $x, float $y, [string $html = ''], mixed $border, int $ln, int $fill)

- float $w: Cell width. If 0, the cell extends up to the right margin.
- float $h: Cell minimum height. The cell extends automatically if needed.
- float $x: upper-left corner X coordinate
- float $y: upper-left corner Y coordinate
- string $html: html text to print. Default value: empty string.
- mixed $border: Indicates if borders must be drawn around the cell. The value can be either a number:
  - 0: no border (default)
  - 1: frame
  or a string containing some or all of the following characters (in any order):
  - L: left
  - T: top
  - R: right
  - B: bottom
- int $ln: Indicates where the current position should go after the call. Possible values are:
  - 0: to the right
  - 1: to the beginning of the next line
  - 2: below
- int $fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.

_begindoc (line 2587)

Start document

- access: protected

void _begindoc ()
_beginpage (line 2993)

_beginpage

- access: protected

void _beginpage (mixed $orientation)
_dochecks (line 2561)

Check for locale-related bug

- access: protected

void _dochecks ()
_dounderline (line 3051)

Underline text

- access: protected

void _dounderline (mixed $x, mixed $y, mixed $txt)
_enddoc (line 2954)

_enddoc

- access: protected

void _enddoc ()
_endpage (line 3033)

End of page contents

- access: protected

void _endpage ()
_escape (line 3225)

Add \ before \, ( and )

- access: protected

void _escape (mixed $s)
_escapetext (line 3213)

Format a text string

- access: protected

void _escapetext (mixed $s)
_freadint (line 3191)

Read a 4-byte integer from file

- access: protected

void _freadint (mixed $f)
_getfontpath (line 2576)

Return fonts path

- access: protected

void _getfontpath ()
_newobj (line 3041)

Begin a new object

- access: protected

void _newobj ()
_out (line 3244)

Add a line to the document

- access: protected

void _out (mixed $s)
_parsejpg (line 3062)

Extract info from a JPEG file

- access: protected

void _parsejpg (mixed $file)
_parsepng (line 3094)

Extract info from a PNG file

- access: protected

void _parsepng (mixed $file)
_putcatalog (line 2906)

_putcatalog

- access: protected

void _putcatalog ()
_putfonts (line 2670)

Adds fonts

_putfonts

- access: protected

void _putfonts ()
_putheader (line 2946)

_putheader

- access: protected

void _putheader ()
_putimages (line 2788)

_putimages

- access: protected

void _putimages ()
_putinfo (line 2882)

_putinfo

- access: protected

void _putinfo ()
_putpages (line 2597)

_putpages

- access: protected

void _putpages ()
_putresourcedict (line 2850)

_putresourcedict

- access: protected

void _putresourcedict ()
_putresources (line 2866)

_putresources

- access: protected

void _putresources ()
_putstream (line 3234)

- access: protected

void _putstream (mixed $s)
_puttrailer (line 2936)

_puttrailer

- access: protected

void _puttrailer ()
_puttruetypeunicode (line 3260)

Adds unicode fonts.

Based on PDF Reference 1.3 (section 5)

- access: protected
- since: 1.52.0.TC005 (2005-01-05)
- author: Nicola Asuni

void _puttruetypeunicode (mixed $font)
_putxobjectdict (line 2840)

_putxobjectdict

- access: protected

void _putxobjectdict ()
_textstring (line 3201)

Format a text string

- access: protected

void _textstring (mixed $s)

Documentation generated on Tue, 20 Mar 2007 13:24:42 +0100 by phpDocumentor 1.3.0RC3