com-tecnick-tcpdf

# Class: TCPDFEX Source Location: /shared/code/tcpdfex.php
### Class Overview
    TCPDF
       |
       --TCPDFEX
This is an extension of the TCPDF class for creating PDF document. #### Author(s): Nicola Asuni - info@tecnick.com #### Version: 5.9.029 | ### Variables $tcexam_backlink | ### Methods Footer Header setTCExamBackLink
### Inherited Variables #### Class: TCPDF TCPDF::$AliasNbPages TCPDF::$AliasNumPage TCPDF::$annotation_fonts TCPDF::$author TCPDF::$AutoPageBreak TCPDF::$barcode TCPDF::$bgcolor TCPDF::$bMargin TCPDF::$booklet TCPDF::$bordermrk TCPDF::$buffer TCPDF::$bufferlen TCPDF::$byterange_string TCPDF::$cache_file_length TCPDF::$cache_maxsize_UTF8StringToArray TCPDF::$cache_size_UTF8StringToArray TCPDF::$cache_UTF8StringToArray TCPDF::$cell_height_ratio TCPDF::$cell_margin TCPDF::$cell_padding TCPDF::$cntmrk TCPDF::$ColorFlag TCPDF::$columns TCPDF::$column_start_page TCPDF::$colxshift TCPDF::$compress TCPDF::$CoreFonts TCPDF::$creator TCPDF::$CurOrientation TCPDF::$CurrentFont TCPDF::$current_column TCPDF::$currpagegroup TCPDF::$customlistindent TCPDF::$default_form_prop TCPDF::$default_graphic_vars TCPDF::$default_monospaced_font TCPDF::$default_table_columns TCPDF::$diffs TCPDF::$diskcache TCPDF::$docinfounicode TCPDF::$dpi TCPDF::$DrawColor TCPDF::$embeddedfiles TCPDF::$emptypagemrk TCPDF::$encoding TCPDF::$encryptdata TCPDF::$encrypted TCPDF::$enc_padding TCPDF::$endlinex TCPDF::$epsmarker TCPDF::$extgstates TCPDF::$feps TCPDF::$fgcolor TCPDF::$fhPt TCPDF::$file_id TCPDF::$FillColor TCPDF::$FontAscent TCPDF::$FontDescent TCPDF::$FontFamily TCPDF::$FontFiles TCPDF::$fontkeys TCPDF::$fontlist TCPDF::$fonts TCPDF::$FontSize TCPDF::$FontSizePt TCPDF::$FontStyle TCPDF::$font_obj_ids TCPDF::$font_spacing TCPDF::$font_stretching TCPDF::$font_subsetting TCPDF::$footerlen TCPDF::$footerpos TCPDF::$footer_font TCPDF::$footer_margin TCPDF::$form_action TCPDF::$form_enctype TCPDF::$form_mode TCPDF::$form_obj_id TCPDF::$fwPt TCPDF::$gradients TCPDF::$h TCPDF::$header_font TCPDF::$header_logo TCPDF::$header_logo_width TCPDF::$header_margin TCPDF::$header_string TCPDF::$header_title TCPDF::$hPt TCPDF::$HREF TCPDF::$htmlLinkColorArray TCPDF::$htmlLinkFontStyle TCPDF::$htmlvspace TCPDF::$imagekeys TCPDF::$images TCPDF::$imgscale TCPDF::$img_rb_x TCPDF::$img_rb_y TCPDF::$InFooter TCPDF::$internal_encoding TCPDF::$inthead TCPDF::$intmrk TCPDF::$inxobj TCPDF::$isunicode TCPDF::$javascript TCPDF::$jpeg_quality TCPDF::$js_objects TCPDF::$k TCPDF::$keywords TCPDF::$l TCPDF::$lasth TCPDF::$last_enc_key TCPDF::$last_enc_key_c TCPDF::$LayoutMode TCPDF::$linestyleCap TCPDF::$linestyleDash TCPDF::$linestyleJoin TCPDF::$linestyleWidth TCPDF::$linethrough TCPDF::$LineWidth TCPDF::$links TCPDF::$lispacer TCPDF::$listcount TCPDF::$listindent TCPDF::$listindentlevel TCPDF::$listnum TCPDF::$listordered TCPDF::$lisymbol TCPDF::$lMargin TCPDF::$maxselcol TCPDF::$n TCPDF::$newline TCPDF::$newpagegroup TCPDF::$numfonts TCPDF::$numimages TCPDF::$numpages TCPDF::$num_columns TCPDF::$n_js TCPDF::$n_ocg_print TCPDF::$n_ocg_view TCPDF::$objcopy TCPDF::$offsets TCPDF::$opencell TCPDF::$openMarkedContent TCPDF::$original_lMargin TCPDF::$original_rMargin TCPDF::$OutlineRoot TCPDF::$outlines TCPDF::$overline TCPDF::$page TCPDF::$PageAnnots TCPDF::$PageBreakTrigger TCPDF::$pagedim TCPDF::$pagegroups TCPDF::$pagelen TCPDF::$PageMode TCPDF::$pageopen TCPDF::$pages TCPDF::$page_obj_id TCPDF::$page_regions TCPDF::$pdfunit TCPDF::$PDFVersion TCPDF::$premode TCPDF::$print_footer TCPDF::$print_header TCPDF::$radiobutton_groups TCPDF::$radio_groups TCPDF::$rasterize_vector_images TCPDF::$re_space TCPDF::$re_spaces TCPDF::$rMargin TCPDF::$rtl TCPDF::$sign TCPDF::$signature_appearance TCPDF::$signature_data TCPDF::$signature_max_length TCPDF::$sig_annot_ref TCPDF::$sig_obj_id TCPDF::$spotcolor TCPDF::$spot_colors TCPDF::$start_transaction_page TCPDF::$start_transaction_y TCPDF::$state TCPDF::$strokecolor TCPDF::$subject TCPDF::$svgclipid TCPDF::$svgclipmode TCPDF::$svgclippaths TCPDF::$svgcliptm TCPDF::$svgdefs TCPDF::$svgdefsmode TCPDF::$svgdir TCPDF::$svggradientid TCPDF::$svggradients TCPDF::$svginheritprop TCPDF::$svgstyles TCPDF::$svgtext TCPDF::$svgtextmode TCPDF::$svgunit TCPDF::$tagvspaces TCPDF::$tcpdf_version TCPDF::$tempfontsize TCPDF::$TextColor TCPDF::$textindent TCPDF::$textrendermode TCPDF::$textstrokewidth TCPDF::$thead TCPDF::$theadMargins TCPDF::$title TCPDF::$tMargin TCPDF::$tmprtl TCPDF::$tocpage TCPDF::$transfmatrix TCPDF::$transfmatrix_key TCPDF::$transfmrk TCPDF::$underline TCPDF::$unicode TCPDF::$ur TCPDF::$viewer_preferences TCPDF::$visibility TCPDF::$w TCPDF::$webcolor TCPDF::$wPt TCPDF::$x TCPDF::$xobjects TCPDF::$xobjid TCPDF::$y TCPDF::$ZoomMode | ### Inherited Methods #### Class: TCPDF TCPDF::__construct() This is the class constructor. TCPDF::AcceptPageBreak() Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value. TCPDF::addExtGState() Add transparency parameters to the current extgstate TCPDF::AddFont() Imports a TrueType, Type1, core, or CID0 font and makes it available. TCPDF::addHtmlLink() Output anchor link. TCPDF::addHTMLTOC() Output a Table Of Content Index (TOC) using HTML templates. TCPDF::addHTMLVertSpace() Add vertical spaces if needed. TCPDF::addJavascriptObject() Adds a javascript object and return object ID TCPDF::AddLink() 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(). TCPDF::AddPage() 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). TCPDF::addPageRegion() Add a single no-write region on selected page. TCPDF::AddSpotColor() Defines a new spot color. TCPDF::addTOC() Output a Table of Content Index (TOC). TCPDF::addTOCPage() Adds a new TOC (Table Of Content) page to the document. TCPDF::adjustCellPadding() Adjust the internal Cell padding array to take account of the line width. TCPDF::AliasNbPages() Defines an alias for the total number of pages. TCPDF::AliasNumPage() Defines an alias for the page number. TCPDF::Annotation() Puts a markup annotation on a rectangular area of the page. TCPDF::Arrow() Draws a grahic arrow. TCPDF::arrUTF8ToUTF16BE() Converts array of UTF-8 characters to UTF16-BE string. TCPDF::Bookmark() Adds a bookmark. TCPDF::Button() Creates a button field TCPDF::Cell() 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. TCPDF::CheckBox() Creates a CheckBox field TCPDF::checkPageBreak() Add page if needed. TCPDF::checkPageRegions() Check page for no-write regions and adapt current coordinates and page margins if necessary. TCPDF::Circle() Draws a circle. TCPDF::Clip() Set a rectangular clipping area. TCPDF::Close() Terminates the PDF document. TCPDF::closeHTMLTagHandler() Process closing tags. TCPDF::colorRegistrationBar() Paints color transition registration bars TCPDF::ComboBox() Creates a Combo-box field TCPDF::commitTransaction() Delete the copy of the current TCPDF object used for undo operation. TCPDF::convertHexStringToString() Convert hexadecimal string to string TCPDF::convertHTMLColorToDec() Returns an array (RGB or CMYK) from an html color name or a six-digit (i.e. #3FE5AA) or three-digit (i.e. #7FF) hexadecimal color representation. TCPDF::convertStringToHexString() Convert string to hexadecimal string (byte string) TCPDF::convertSVGtMatrix() Convert SVG transformation matrix to PDF. TCPDF::CoonsPatchMesh() Paints a coons patch mesh. TCPDF::copyPage() Clone the specified page to a new page. TCPDF::cropMark() Paints crop mark TCPDF::Curve() Draws a Bezier curve. TCPDF::deletePage() Remove the specified page. TCPDF::drawHTMLTagBorder() Draw an HTML block border and fill TCPDF::Ellipse() Draws an ellipse. TCPDF::empty_string() Determine whether a string is empty. TCPDF::endPage() Terminate the current page TCPDF::endSVGElementHandler() Sets the closing SVG element handler function for the XML parser. TCPDF::endTemplate() End the current XObject Template started with startTemplate() and restore the previous graphic state. TCPDF::endTOCPage() Terminate the current TOC (Table Of Content) page TCPDF::Error() 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. TCPDF::extractCSSproperties() Extracts the CSS properties from a CSS string. TCPDF::fitBlock() Set the block dimensions accounting for page breaks and page/column fitting TCPDF::fixHTMLCode() Cleanup HTML code (requires HTML Tidy library). TCPDF::Footer() This method is used to render the page footer. TCPDF::formatPageNumber() Format the page numbers. TCPDF::formatTOCPageNumber() Format the page numbers on the Table Of Content. TCPDF::GetAbsX() Returns the absolute X value of current position. TCPDF::getAliasNbPages() Returns the string alias used for the total number of pages. TCPDF::getAliasNumPage() Returns the string alias used for the page number. TCPDF::getAnnotOptFromJSProp() Convert JavaScript form fields properties array to Annotation Properties array. TCPDF::GetArrStringWidth() Returns the string length of an array of chars in user unit or an array of characters widths. A font must be selected. TCPDF::getBarcode() Get current barcode. TCPDF::getBorderMode() Get the border mode accounting for multicell position (opens bottom side of multicell crossing pages) TCPDF::getBorderStartPosition() Return the starting coordinates to draw an html border TCPDF::getBreakMargin() Returns the page break margin. TCPDF::getBuffer() Get buffer content. TCPDF::getCellBorder() Returns the code to draw the cell border TCPDF::getCellCode() 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. If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting. TCPDF::getCellHeightRatio() return the height of cell repect font height. TCPDF::getCellMargins() Get the internal Cell margin array. TCPDF::getCellPaddings() Get the internal Cell padding array. TCPDF::GetCharWidth() Returns the length of the char in user unit for the current font considering current stretching and spacing (tracking/kerning). TCPDF::getColumn() Return the current column number TCPDF::getCSSBorderDashStyle() Returns the border dash style from CSS property TCPDF::getCSSBorderMargin() Get the border-spacing from CSS attribute. TCPDF::getCSSBorderStyle() Returns the border style array from CSS border properties TCPDF::getCSSBorderWidth() Returns the border width from CSS property TCPDF::getCSSFontSpacing() Returns the letter-spacing value from CSS value TCPDF::getCSSFontStretching() Returns the percentage of font stretching from CSS value TCPDF::getCSSMargin() Get the internal Cell margin from CSS attribute. TCPDF::getCSSPadding() Get the internal Cell padding from CSS attribute. TCPDF::getEncPermissionsString() Convert encryption P value to a string of bytes, low-order byte first. TCPDF::getFontAscent() Return the font ascent value TCPDF::getFontBuffer() Get font buffer content. TCPDF::getFontDescent() Return the font descent value TCPDF::getFontFamily() Returns the current font family name. TCPDF::getFontFamilyName() Return normalized font name TCPDF::getFontSize() Returns the current font size. TCPDF::getFontSizePt() Returns the current font size in points unit. TCPDF::getFontsList() Fill the list of available fonts ($this->fontlist). TCPDF::getFontSpacing() Get the amount to increase or decrease the space between characters in a text. TCPDF::getFontStretching() Get the percentage of character stretching. TCPDF::getFontStyle() Returns the current font style. TCPDF::getFontSubsetting() Return the default option for font subsetting. TCPDF::getFooterFont() Get Footer font. TCPDF::getFooterMargin() Returns footer margin in user units. TCPDF::getFormDefaultProp() Return the default properties for form fields. TCPDF::getGDgamma() Correct the gamma value to be used with GD library TCPDF::getGraphicVars() Returns current graphic variables as array. TCPDF::getGroupPageNo() Return the current page in the group. TCPDF::getGroupPageNoFormatted() Returns the current group page number formatted as a string. TCPDF::getHeaderData() Returns header data: TCPDF::getHeaderFont() Get header font. TCPDF::getHeaderMargin() Returns header margin in user units. TCPDF::getHtmlDomArray() Returns the HTML DOM array. TCPDF::getHTMLUnitToUnits() Convert HTML string containing value and unit of measure to user's units or points. TCPDF::getHyphenPatternsFromTEX() Returns an array of hyphenation patterns. TCPDF::getImageBuffer() Get image buffer content. TCPDF::getImageFileType() Return the image type given the file name or array returned by getimagesize() function. TCPDF::getImageRBX() Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image TCPDF::getImageRBY() Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image TCPDF::getImageScale() Returns the adjusting factor to convert pixels to user units. TCPDF::getLastH() Get the last cell height. TCPDF::GetLineWidth() Returns the current the line width. TCPDF::getMargins() Returns an array containing current margins: TCPDF::getNumberOfColumns() Return the current number of columns. TCPDF::GetNumChars() Returns the numbero of characters in a string. TCPDF::getNumLines() This method return the estimated number of lines for print a simple text string using Multicell() method. TCPDF::getNumPages() Get the total number of insered pages. TCPDF::getObjFilename() Returns a temporary filename for caching object on filesystem. TCPDF::getOriginalMargins() Returns an array containing original margins: TCPDF::getPage() Get current document page number. TCPDF::getPageBuffer() Get page buffer content. TCPDF::getPageDimensions() Returns an array of page dimensions: TCPDF::getPageGroupAlias() Return the alias of the current page group If the current font is unicode type, the returned string is surrounded by additional curly braces. TCPDF::getPageHeight() Returns the page height in units. TCPDF::getPageNumGroupAlias() 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. TCPDF::getPageRegions() Return an array of no-write page regions TCPDF::getPageSizeFromFormat() Get page dimensions from format name. TCPDF::getPageWidth() Returns the page width in units. TCPDF::getPathPaintOperator() Get the Path-Painting Operators. TCPDF::getPDFData() Returns the PDF data. TCPDF::getRandomSeed() Returns a string containing random data to be used as a seed for encryption methods. TCPDF::getRawCharWidth() Returns the length of the char in user unit for the current font. TCPDF::getRemainingWidth() Returns the remaining width between the current position and margins. TCPDF::getRTL() Return the RTL status TCPDF::getScaleFactor() Returns the scale factor (number of points in user unit). TCPDF::getSpaceString() Returns the string used to find spaces TCPDF::getStringHeight() This method return the estimated needed height for print a simple text string in Multicell() method. TCPDF::GetStringWidth() Returns the length of a string in user unit. A font must be selected. TCPDF::getSVGTransformMatrix() Get the tranformation matrix from SVG transform attribute TCPDF::getTagStyleFromCSS() Returns the styles that apply for the selected HTML tag. TCPDF::getTCPDFVersion() Return the current TCPDF version. TCPDF::getTransformationMatrixProduct() Get the product of two SVG tranformation matrices TCPDF::getUserPermissionCode() Return the premission code used on encryption (P value). TCPDF::getVectorsAngle() Returns the angle in radiants between two vectors TCPDF::GetX() Returns the relative X value of current position. TCPDF::GetY() Returns the ordinate of the current position. TCPDF::get_mqr() Gets the current active configuration setting of magic_quotes_runtime (if the get_magic_quotes_runtime function exist) TCPDF::Gradient() Output gradient. TCPDF::Header() This method is used to render the page header. TCPDF::hyphenateText() Returns text with soft hyphens. TCPDF::hyphenateWord() Returns an array of chars containing soft hyphens. TCPDF::Image() Puts an image in the page. TCPDF::ImageEps() Embed vector-based Adobe Illustrator (AI) or AI-compatible EPS files. TCPDF::ImagePngAlpha() Extract info from a PNG image with alpha channel using the GD library. TCPDF::ImageSVG() Embedd a Scalable Vector Graphics (SVG) image. TCPDF::IncludeJS() Adds a javascript TCPDF::intToRoman() Returns the Roman representation of an integer number TCPDF::isRTLTextDir() Return the current temporary RTL status TCPDF::isUnicodeFont() Return true if the current font is unicode type. TCPDF::isValidCSSSelectorForTag() Returns true if the CSS selector is valid for the selected HTML tag TCPDF::lastPage() Reset pointer to the last document page. TCPDF::Line() Draws a line between two points. TCPDF::LinearGradient() Paints a linear colour gradient. TCPDF::Link() Puts a link on a rectangular area of the page. TCPDF::ListBox() Creates a List-box field TCPDF::Ln() Performs a line break. TCPDF::MirrorH() Horizontal Mirroring. TCPDF::MirrorL() Reflection against a straight line through point (x, y) with the gradient angle (angle). TCPDF::MirrorP() Point reflection mirroring. TCPDF::MirrorV() Verical Mirroring. TCPDF::movePage() Move a page to a previous position. TCPDF::MultiCell() This method allows printing text with line breaks. TCPDF::objclone() Creates a copy of a class object TCPDF::Open() This method begins the generation of the PDF document. TCPDF::openHTMLTagHandler() Process opening tags. TCPDF::Output() Send the document to a given destination: string, local file or browser. TCPDF::PageNo() Returns the current page number. TCPDF::PageNoFormatted() Returns the current page number formatted as a string. TCPDF::PieSector() Draw the sector of a circle. TCPDF::PieSectorXY() Draw the sector of an ellipse. TCPDF::pixelsToUnits() Converts pixels to User's Units. TCPDF::Polycurve() Draws a poly-Bezier curve. TCPDF::Polygon() Draws a polygon. TCPDF::PolyLine() Draws a polygonal line TCPDF::printTemplate() Print an XObject Template. TCPDF::putHtmlListBullet() Output an HTML list bullet or ordered item symbol TCPDF::RadialGradient() Paints a radial colour gradient. TCPDF::RadioButton() Creates a RadioButton field TCPDF::readDiskCache() Read data from a temporary file on filesystem. TCPDF::Rect() Draws a rectangle. TCPDF::registrationMark() Paints a registration mark TCPDF::RegularPolygon() Draws a regular polygon. TCPDF::removePageRegion() Remove a single no-write region. TCPDF::removeSHY() Removes SHY characters from text. TCPDF::replaceBuffer() Replace the buffer content TCPDF::resetLastH() Reset the last cell height. TCPDF::revstrpos() Find position of last occurrence of a substring in a string TCPDF::rfread() Binary-safe and URL-safe file read. TCPDF::rollbackTransaction() This method allows to undo the latest transaction by returning the latest saved TCPDF object with startTransaction(). TCPDF::Rotate() Rotate object. TCPDF::RoundedRect() Draws a rounded rectangle. TCPDF::RoundedRectXY() Draws a rounded rectangle. TCPDF::Scale() Vertical and horizontal non-proportional Scaling. TCPDF::ScaleX() Horizontal Scaling. TCPDF::ScaleXY() Vertical and horizontal proportional Scaling. TCPDF::ScaleY() Vertical Scaling. TCPDF::segSVGContentHandler() Sets the character data handler function for the XML parser. TCPDF::selectColumn() Set position at a given column TCPDF::serializeTCPDFtagParameters() Serialize an array of parameters to be used with TCPDF tag in HTML code. TCPDF::setAlpha() Set alpha for stroking (CA) and non-stroking (ca) operations. TCPDF::SetAuthor() Defines the author of the document. TCPDF::SetAutoPageBreak() 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. TCPDF::setBarcode() Set document barcode. TCPDF::SetBooklet() Set the booklet mode for double-sided pages. TCPDF::setBuffer() Set buffer content (always append data). TCPDF::setCellHeightRatio() Set the height of the cell (line height) respect the font height. TCPDF::setCellMargins() Set the internal Cell margins. TCPDF::SetCellPadding() Set the same internal Cell padding for top, right, bottom, left- TCPDF::setCellPaddings() Set the internal Cell paddings. TCPDF::setColumnsArray() Set columns array. TCPDF::SetCompression() 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. TCPDF::setContentMark() Set start-writing mark on selected page. TCPDF::SetCreator() Defines the creator of the document. This is typically the name of the application that generates the PDF. TCPDF::SetDefaultMonospacedFont() Defines the default monospaced font. TCPDF::setDefaultTableColumns() Set the default number of columns in a row for HTML tables. TCPDF::SetDisplayMode() Defines the way the document is to be displayed by the viewer. TCPDF::SetDocInfoUnicode() Turn on/off Unicode mode for document information dictionary (meta tags). TCPDF::SetDrawColor() 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. TCPDF::SetDrawColorArray() Defines the color used for all drawing operations (lines, rectangles and cell borders). TCPDF::SetDrawSpotColor() Defines the spot color used for all drawing operations (lines, rectangles and cell borders). TCPDF::setEqualColumns() Set multiple columns of the same size TCPDF::setExtGState() Add an extgstate TCPDF::SetFillColor() 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. TCPDF::SetFillColorArray() Defines the color used for all filling operations (filled rectangles and cell backgrounds). TCPDF::SetFillSpotColor() Defines the spot color used for all filling operations (filled rectangles and cell backgrounds). TCPDF::SetFont() Sets the font used to print character strings. TCPDF::setFontBuffer() Set font buffer content. TCPDF::SetFontSize() Defines the size of the current font. TCPDF::setFontSpacing() Set the amount to increase or decrease the space between characters in a text. TCPDF::setFontStretching() Set the percentage of character stretching. TCPDF::setFontSubBuffer() Set font buffer content. TCPDF::setFontSubsetting() Enable or disable default option for font subsetting. TCPDF::setFooter() This method is used to render the page footer. TCPDF::setFooterFont() Set footer font. TCPDF::setFooterMargin() Set footer margin. TCPDF::setFormDefaultProp() Set default properties for form fields. TCPDF::setGraphicVars() Set graphic variables. TCPDF::setHeader() This method is used to render the page header. TCPDF::setHeaderData() Set header data. TCPDF::setHeaderFont() Set header font. TCPDF::setHeaderMargin() Set header margin. TCPDF::setHtmlLinksStyle() Set the color and font style for HTML links. TCPDF::setHtmlVSpace() Set the vertical spaces for HTML tags. TCPDF::setImageBuffer() Set image buffer content. TCPDF::setImageScale() Set the adjusting factor to convert pixels to user units. TCPDF::setImageSubBuffer() Set image buffer content for a specified sub-key. TCPDF::setJPEGQuality() Set the default JPEG compression quality (1-100) TCPDF::SetKeywords() Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'. TCPDF::setLanguageArray() Set language array. TCPDF::setLastH() Set the last cell height. TCPDF::SetLeftMargin() 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. TCPDF::SetLineStyle() Set line style. TCPDF::SetLineWidth() 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. TCPDF::SetLink() Defines the page and position a link points to. TCPDF::setListIndentWidth() Set custom width for list indentation. TCPDF::setLIsymbol() Set the default bullet to be used as LI bullet symbol TCPDF::SetMargins() Defines the left, top and right margins. TCPDF::setOpenCell() Set the top/bottom cell sides to be open or closed when the cell cross the page. TCPDF::setPage() Move pointer at the specified document page and update page dimensions. TCPDF::setPageBoxes() Set page boundaries. TCPDF::setPageBuffer() Set page buffer content. TCPDF::setPageFormat() Change the format of the current page TCPDF::setPageMark() Set start-writing mark on current page stream used to put borders and fills. TCPDF::setPageOrientation() Set page orientation. TCPDF::setPageRegions() Set no-write regions on page. TCPDF::setPageUnit() Set the units of measure for the document. TCPDF::setPDFVersion() Set the PDF version (check PDF reference for valid values). TCPDF::setPrintFooter() Set a flag to print page footer. TCPDF::setPrintHeader() Set a flag to print page header. TCPDF::SetProtection() Set document protection Remark: the protection against modification is for people who have the full Acrobat product. TCPDF::setRasterizeVectorImages() Enable/disable rasterization of vector images using ImageMagick library. TCPDF::SetRightMargin() Defines the right margin. The method can be called before creating the first page. TCPDF::setRTL() Enable or disable Right-To-Left language mode TCPDF::setSignature() Enable document signature (requires the OpenSSL Library). TCPDF::setSignatureAppearance() Set the digital signature appearance (a cliccable rectangle area to get signature properties) TCPDF::setSpacesRE() Set regular expression to detect withespaces or word separators. TCPDF::SetSubject() Defines the subject of the document. TCPDF::setSVGStyles() Apply the requested SVG styles (*** TO BE COMPLETED ***) TCPDF::setTableHeader() This method is used to render the table header on new page (if any). TCPDF::setTempRTL() Force temporary RTL language direction TCPDF::SetTextColor() 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. TCPDF::SetTextColorArray() Defines the color used for text. It can be expressed in RGB components or gray scale. TCPDF::setTextRenderingMode() Set Text rendering mode. TCPDF::SetTextSpotColor() Defines the spot color used for text. TCPDF::SetTitle() Defines the title of the document. TCPDF::SetTopMargin() Defines the top margin. The method can be called before creating the first page. TCPDF::setUserRights() Set User's Rights for PDF Reader WARNING: This is experimental and currently do not work. TCPDF::setViewerPreferences() Set the viewer preferences dictionary controlling the way the document is to be presented on the screen or in print. TCPDF::setVisibility() Set the visibility of the successive elements. TCPDF::SetX() Defines the abscissa of the current position. TCPDF::SetXY() Defines the abscissa and ordinate of the current position. TCPDF::SetY() Moves the current abscissa back to the left margin and sets the ordinate. TCPDF::set_mqr() Sets the current active configuration setting of magic_quotes_runtime (if the set_magic_quotes_runtime function exist) TCPDF::Skew() Skew. TCPDF::SkewX() Skew horizontally. TCPDF::SkewY() Skew vertically. TCPDF::StarPolygon() Draws a star polygon TCPDF::startPage() Starts a new page to the document. The page must be closed using the endPage() function. TCPDF::startPageGroup() Create a new page group. TCPDF::startSVGElementHandler() Sets the opening SVG element handler function for the XML parser. (*** TO BE COMPLETED ***) TCPDF::startTemplate() Start a new XObject Template. TCPDF::startTransaction() Stores a copy of the current TCPDF object used for undo operation. TCPDF::StartTransform() Starts a 2D tranformation saving current graphic state. TCPDF::StopTransform() Stops a 2D tranformation restoring previous graphic state. TCPDF::stringLeftTrim() Left trim the input string TCPDF::stringRightTrim() Right trim the input string TCPDF::stringTrim() Trim the input string TCPDF::SVGPath() Draws an SVG path TCPDF::SVGTransform() Apply SVG graphic transformation matrix. TCPDF::swapMargins() Swap the left and right margins. TCPDF::swapPageBoxCoordinates() Swap X and Y coordinates of page boxes (change page boxes orientation). TCPDF::Text() Prints a text cell at the specified position. TCPDF::TextField() Creates a text field TCPDF::Transform() Apply graphic transformations. TCPDF::Translate() Translate graphic object horizontally and vertically. TCPDF::TranslateX() Translate graphic object horizontally. TCPDF::TranslateY() Translate graphic object vertically. TCPDF::unhtmlentities() Reverse function for htmlentities. TCPDF::UniArrSubString() Extract a slice of the $uniarr array and return it as string. TCPDF::unichr() Returns the unicode caracter specified by UTF-8 value TCPDF::UTF8ArrayToUniArray() Convert an array of UTF8 values to array of unicode characters TCPDF::UTF8ArrSubString() Extract a slice of the $strarr array and return it as string. TCPDF::UTF8ArrToLatin1() Converts UTF-8 characters array to array of Latin1 characters TCPDF::utf8Bidi() Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/). TCPDF::utf8StrArrRev() Reverse the RLT substrings array using the Bidirectional Algorithm (http://unicode.org/reports/tr9/). TCPDF::UTF8StringToArray() Converts UTF-8 strings to codepoints array. TCPDF::utf8StrRev() Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/). TCPDF::UTF8ToLatin1() Converts UTF-8 strings to Latin1 when using the standard 14 core fonts. TCPDF::UTF8ToUTF16BE() Converts UTF-8 strings to UTF16-BE. TCPDF::Write() This method prints text from the current position. TCPDF::write1DBarcode() Print a Linear Barcode. TCPDF::write2DBarcode() Print 2D Barcode. TCPDF::writeBarcode() This function is DEPRECATED, please use the new write1DBarcode() function. TCPDF::writeDiskCache() Writes data to a temporary file on filesystem. TCPDF::writeHTML() Allows to preserve some HTML formatting (limited support). IMPORTANT: The HTML must be well formatted - try to clean-up it using an application like HTML-Tidy before submitting. TCPDF::writeHTMLCell() Prints a cell (rectangular area) with optional borders, background color and html text string. TCPDF::_addfield() Adds a javascript form field. TCPDF::_AES() Returns the input text exrypted using AES algorithm and the specified key. TCPDF::_beginpage() Initialize a new page. TCPDF::_datastring() Format a data string for meta information TCPDF::_datestring() Returns a formatted date for meta information TCPDF::_destroy() Unset all class variables except the following critical variables: internal_encoding, state, bufferlen, buffer and diskcache. TCPDF::_dochecks() Check for locale-related bug TCPDF::_dolinethrough() Line through text. TCPDF::_dolinethroughw() Line through for rectangular text area. TCPDF::_dooverline() Overline text. TCPDF::_dooverlinew() Overline for rectangular text area. TCPDF::_dounderline() Underline text. TCPDF::_dounderlinew() Underline for rectangular text area. TCPDF::_encrypt_data() Encrypt the input string. TCPDF::_enddoc() Output end of document (EOF). TCPDF::_endpage() Mark end of page. TCPDF::_escape() Add "\" before "\", "(" and ")" TCPDF::_escapetext() THIS METHOD IS DEPRECATED TCPDF::_fixAES256Password() Convert password for AES-256 encryption mode TCPDF::_freadint() Read a 4-byte (32 bit) integer from file. TCPDF::_generateencryptionkey() Compute encryption key TCPDF::_getannotsrefs() Get references to page annotations. TCPDF::_getBYTE() Get BYTE from string (8-bit unsigned integer). TCPDF::_getfontpath() Return fonts path TCPDF::_getobj() Return the starting object string for the selected object ID. TCPDF::_getrawstream() get raw output stream. TCPDF::_getSHORT() Get SHORT from string (Big Endian 16-bit signed integer). TCPDF::_getstream() Format output stream (DEPRECATED). TCPDF::_getTrueTypeFontSubset() Returns a subset of the TrueType font data without the unused glyphs. TCPDF::_getTTFtableChecksum() Returs the checksum of a TTF table. TCPDF::_getULONG() Get ULONG from string (Big Endian 32-bit unsigned integer). TCPDF::_getUSHORT() Get USHORT from string (Big Endian 16-bit unsigned integer). TCPDF::_getxobjectdict() Return XObjects Dictionary. TCPDF::_JScolor() Convert color to javascript color. TCPDF::_md5_16() Encrypts a string using MD5 and returns it's value as a binary string. TCPDF::_newobj() Begin a new object and return the object number. TCPDF::_objectkey() Compute encryption key depending on object number where the encrypted data is stored. TCPDF::_OEvalue() Compute OE value (used for encryption) TCPDF::_out() Output a string to the document. TCPDF::_outCurve() Append a cubic Bézier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x2, y2) as the Bézier control points. TCPDF::_outCurveV() Append a cubic Bézier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using the current point and (x2, y2) as the Bézier control points. TCPDF::_outCurveY() Append a cubic Bézier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x3, y3) as the Bézier control points. TCPDF::_outellipticalarc() Append an elliptical arc to the current path. TCPDF::_outLine() Append a straight line segment from the current point to the point (x, y). TCPDF::_outPoint() Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment. TCPDF::_outRect() Append a rectangle to the current path as a complete subpath, with lower-left corner (x, y) and dimensions widthand height in user space. TCPDF::_Ovalue() Compute O value (used for encryption) TCPDF::_parsejpeg() Extract info from a JPEG file without using the GD library. TCPDF::_parsepng() Extract info from a PNG file without using the GD library. TCPDF::_putannotsobjs() Output annotations objects for all pages. TCPDF::_putannotsrefs() Output references to page annotations TCPDF::_putAPXObject() Put appearance streams XObject used to define annotation's appearance states TCPDF::_putbookmarks() Create a bookmark PDF string. TCPDF::_putcatalog() Output Catalog. TCPDF::_putcidfont0() Output CID-0 fonts. TCPDF::_putEmbeddedFiles() Embedd the attached files. TCPDF::_putencryption() Put encryption on PDF document. TCPDF::_putextgstates() Put extgstates for object transparency TCPDF::_putfonts() Output fonts. TCPDF::_putfontwidths() Outputs font widths TCPDF::_putheader() Output PDF header. TCPDF::_putimages() Output images. TCPDF::_putinfo() Adds some Metadata information (Document Information Dictionary) TCPDF::_putjavascript() Create a javascript PDF string. TCPDF::_putocg() Put visibility settings. TCPDF::_putpages() Output pages. TCPDF::_putresourcedict() Output Resources Dictionary. TCPDF::_putresources() Output Resources. TCPDF::_putshaders() Output gradient shaders. TCPDF::_putsignature() Add certification signature (DocMDP or UR3) TCPDF::_putspotcolors() Output Spot Colors Resources. TCPDF::_putstream() Output a stream (DEPRECATED). TCPDF::_puttruetypeunicode() Adds unicode fonts. TCPDF::_putviewerpreferences() Output viewer preferences. TCPDF::_putxobjects() Output Form XObjects Templates. TCPDF::_RC4() Returns the input text encrypted using RC4 algorithm and the specified key. TCPDF::_setGDImageTransparency() Set the transparency for the given GD image. TCPDF::_textstring() Format a text string for meta information TCPDF::_toJPEG() Convert the loaded image to a JPEG and then return a structure for the PDF creator. TCPDF::_toPNG() Convert the loaded image to a PNG and then return a structure for the PDF creator. TCPDF::_UEvalue() Compute UE value (used for encryption) TCPDF::_Uvalue() Compute U value (used for encryption) TCPDF::__destruct() Default destructor.
### Class Details [line 58] This is an extension of the TCPDF class for creating PDF document. This extension allows you to define custom Header and Footer for PDF documents. #### Tags:
author: | Nicola Asuni - info@tecnick.com
version: | 5.9.029
link: | http://www.tcpdf.org
name: | TCPDFEX
license: | GNU-LGPLv3 + YOU CAN'T REMOVE ANY TCPDF COPYRIGHT NOTICE OR LINK FROM THE GENERATED PDF DOCUMENTS.
[ Top ] ### Class Variables #### $tcexam_backlink = '' [line 64] #### Tags:
var: | link that points back to TCExam website.
access: | protected
Type: | URL
[ Top ] ### Class Methods ### method Footer [line 113]
`void Footer( )`
This method is used to render the page footer and overrides the original Footer() method on TCPDF. #### Tags:
access: | public
Overrides TCPDF::Footer() (This method is used to render the page footer.) [ Top ] ### method Header [line 79]
`void Header( )`
This method is used to render the page header and overrides the original Header() method on TCPDF. #### Tags:
access: | public
Overrides TCPDF::Header() (This method is used to render the page header.) [ Top ] ### method setTCExamBackLink [line 71]
`void setTCExamBackLink( $link $link)`
Set an URL link that points back to TCExam website (this will be printed as QR-Code on header). #### Tags:
access: | public
#### Parameters:
$link | $link | URL link.
[ Top ] Documentation generated on Mon, 06 Dec 2010 12:03:12 +0100 by phpDocumentor 1.4.3