TCPDF
Description Description
Source Source
File: includes/lib/tcpdf/tcpdf.php
Methods Methods
- __construct — This is the class constructor.
- __destruct — Default destructor.
- _addfield — Adds a javascript form field.
- _beginpage — Initialize a new page.
- _datastring — Format a data string for meta information
- _datestring — Returns a formatted date for meta information
- _destroy — Unset all class variables except the following critical variables.
- _dochecks — Check for locale-related bug
- _dolinethrough — Line through text.
- _dolinethroughw — Line through for rectangular text area.
- _dooverline — Overline text.
- _dooverlinew — Overline for rectangular text area.
- _dounderline — Underline text.
- _dounderlinew — Underline for rectangular text area.
- _encrypt_data — Encrypt the input string.
- _enddoc — Output end of document (EOF).
- _endpage — Mark end of page.
- _fixAES256Password — Convert password for AES-256 encryption mode
- _generateencryptionkey — Compute encryption key
- _getannotsrefs — Get references to page annotations.
- _getobj — Return the starting object string for the selected object ID.
- _getrawstream — get raw output stream.
- _getxobjectdict — Return XObjects Dictionary.
- _newobj — Begin a new object and return the object number.
- _objectkey — Compute encryption key depending on object number where the encrypted data is stored.
- _OEvalue — Compute OE value (used for encryption)
- _out — Output a string to the document.
- _outCurve — Append a cubic Bezier 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 Bezier control points.
- _outCurveV — Append a cubic Bezier 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 Bezier control points.
- _outCurveY — Append a cubic Bezier 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 Bezier control points.
- _outellipticalarc — Append an elliptical arc to the current path.
- _outLine — Append a straight line segment from the current point to the point (x, y).
- _outPoint — Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment.
- _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.
- _outRestoreGraphicsState — Outputs the "restore graphics state" operator 'Q'
- _outSaveGraphicsState — Outputs the "save graphics state" operator 'q'
- _Ovalue — Compute O value (used for encryption)
- _putannotsobjs — Output annotations objects for all pages.
- _putAPXObject — Put appearance streams XObject used to define annotation's appearance states.
- _putbookmarks — Create a bookmark PDF string.
- _putcatalog — Output Catalog.
- _putcidfont0 — Output CID-0 fonts.
- _putdests — Insert Named Destinations.
- _putEmbeddedFiles — Embedd the attached files.
- _putencryption — Put encryption on PDF document.
- _putextgstates — Put extgstates for object transparency
- _putfonts — Output fonts.
- _putheader — Output PDF File Header (7.5.2).
- _putimages — Output images.
- _putinfo — Adds some Metadata information (Document Information Dictionary) (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference)
- _putjavascript — Create a javascript PDF string.
- _putocg — Put pdf layers.
- _putpages — Output pages (and replace page number aliases).
- _putresourcedict — Output Resources Dictionary.
- _putresources — Output Resources.
- _putshaders — Output gradient shaders.
- _putsignature — Add certification signature (DocMDP or UR3) You can set only one signature type
- _putspotcolors — Output Spot Colors Resources.
- _puttruetypeunicode — Adds unicode fonts. Based on PDF Reference 1.3 (section 5)
- _putviewerpreferences — Output viewer preferences.
- _putXMP — Put XMP data object and return ID.
- _putxobjects — Output Form XObjects Templates.
- _textstring — Format a text string for meta information
- _UEvalue — Compute UE value (used for encryption)
- _Uvalue — Compute U value (used for encryption)
- AcceptPageBreak — Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value.
- addEmptySignatureAppearance — Add an empty digital signature appearance (a cliccable rectangle area to get signature properties)
- addExtGState — Add transparency parameters to the current extgstate
- AddFont — Imports a TrueType, Type1, core, or CID0 font and makes it available.
- addHtmlLink — Output anchor link.
- addHTMLTOC — Output a Table Of Content Index (TOC) using HTML templates.
- addHTMLVertSpace — Add vertical spaces if needed.
- addJavascriptObject — Adds a javascript object and return object ID
- 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().
- 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).
- addPageRegion — Add a single no-write region on selected page.
- AddSpotColor — Defines a new spot color.
- addTOC — Output a Table of Content Index (TOC).
- addTOCPage — Adds a new TOC (Table Of Content) page to the document.
- adjustCellPadding — Adjust the internal Cell padding array to take account of the line width.
- Annotation — Puts a markup annotation on a rectangular area of the page.
- applyTSA — NOT YET IMPLEMENTED Request TSA for a timestamp
- Arrow — Draws a grahic arrow.
- Bookmark — Adds a bookmark.
- Button — Creates a button field
- 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.
- CheckBox — Creates a CheckBox field
- checkPageBreak — Add page if needed.
- checkPageRegions — Check page for no-write regions and adapt current coordinates and page margins if necessary.
- Circle — Draws a circle.
- Clip — Set a rectangular clipping area.
- Close — Terminates the PDF document.
- closeHTMLTagHandler — Process closing tags.
- colorRegistrationBar — Paints color transition registration bars
- ComboBox — Creates a Combo-box field
- commitTransaction — Delete the copy of the current TCPDF object used for undo operation.
- convertSVGtMatrix — Convert SVG transformation matrix to PDF.
- CoonsPatchMesh — Paints a coons patch mesh.
- copyPage — Clone the specified page to a new page.
- cropMark — Paints crop marks.
- Curve — Draws a Bezier curve.
- deletePage — Remove the specified page.
- drawHTMLTagBorder — Draw an HTML block border and fill
- Ellipse — Draws an ellipse.
- endLayer — End the current PDF layer.
- endPage — Terminate the current page
- endSVGElementHandler — Sets the closing SVG element handler function for the XML parser.
- endTemplate — End the current XObject Template started with startTemplate() and restore the previous graphic state.
- endTOCPage — Terminate the current TOC (Table Of Content) page
- Error — Throw an exception or print an error message and die if the K_TCPDF_PARSER_THROW_EXCEPTION_ERROR constant is set to true.
- fitBlock — Set the block dimensions accounting for page breaks and page/column fitting
- fixHTMLCode — Cleanup HTML code (requires HTML Tidy library).
- Footer — This method is used to render the page footer.
- getAbsFontMeasure — Convert a relative font measure into absolute value.
- GetAbsX — Returns the absolute X value of current position.
- getAliasNbPages — Returns the string alias used for the total number of pages.
- getAliasNumPage — Returns the string alias used for the page number.
- getAliasRightShift — Returns the string alias used right align page numbers.
- getAllInternalPageNumberAliases — Return an array containing all internal page aliases.
- getAllSpotColors — Returns the array of spot colors.
- getAlpha — Get the alpha mode array (CA, ca, BM, AIS).
- GetArrStringWidth — Returns the string length of an array of chars in user unit or an array of characters widths. A font must be selected.
- getAutoPageBreak — Return the auto-page-break mode (true or false).
- getBarcode — Get current barcode.
- getBorderStartPosition — Return the starting coordinates to draw an html border
- getBreakMargin — Returns the page break margin.
- getBuffer — Get buffer content.
- getCellBorder — Returns the code to draw the cell border
- 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.
- getCellHeight — Return the cell height
- getCellHeightRatio — return the height of cell repect font height.
- getCellMargins — Get the internal Cell margin array.
- getCellPaddings — Get the internal Cell padding array.
- getCharBBox — Returns the glyph bounding box of the specified character in the current font in user units.
- GetCharWidth — Returns the length of the char in user unit for the current font considering current stretching and spacing (tracking).
- getColumn — Return the current column number
- getCSSBorderDashStyle — Returns the border dash style from CSS property
- getCSSBorderMargin — Get the border-spacing from CSS attribute.
- getCSSBorderStyle — Returns the border style array from CSS border properties
- getCSSBorderWidth — Returns the border width from CSS property
- getCSSFontSpacing — Returns the letter-spacing value from CSS value
- getCSSFontStretching — Returns the percentage of font stretching from CSS value
- getCSSMargin — Get the internal Cell margin from CSS attribute.
- getCSSPadding — Get the internal Cell padding from CSS attribute.
- getDestination — Return the Named Destination array.
- getDocCreationTimestamp — Returns document creation timestamp in seconds.
- getDocModificationTimestamp — Returns document modification timestamp in seconds.
- getFontAscent — Return the font ascent value.
- getFontBBox — Returns the bounding box of the current font in user units.
- getFontBuffer — Get font buffer content.
- getFontDescent — Return the font descent value
- getFontFamily — Returns the current font family name.
- getFontFamilyName — Return normalized font name
- getFontSize — Returns the current font size.
- getFontSizePt — Returns the current font size in points unit.
- getFontsList — Fill the list of available fonts ($this->fontlist).
- getFontSpacing — Get the amount to increase or decrease the space between characters in a text.
- getFontStretching — Get the percentage of character stretching.
- getFontStyle — Returns the current font style.
- getFontSubsetting — Return the default option for font subsetting.
- getFooterFont — Get Footer font.
- getFooterMargin — Returns footer margin in user units.
- getFormDefaultProp — Return the default properties for form fields.
- getGDgamma — Get the GD-corrected PNG gamma value from alpha color
- getGraphicVars — Returns current graphic variables as array.
- getGroupPageNo — Return the current page in the group.
- getGroupPageNoFormatted — Returns the current group page number formatted as a string.
- getHashForTCPDFtagParams — Return an hash code used to ensure that the serialized data has been generated by this TCPDF instance.
- getHeaderData — Returns header data: $ret['logo'] = logo image$ret['logo_width'] = width of the image logo in user units$ret['title'] = header title$ret['string'] = header description string
- getHeaderFont — Get header font.
- getHeaderMargin — Returns header margin in user units.
- getHtmlDomArray — Returns the HTML DOM array.
- getHTMLFontUnits — Convert HTML string containing font size value to points
- getHTMLUnitToUnits — Convert HTML string containing value and unit of measure to user's units or points.
- getImageBuffer — Get image buffer content.
- getImageRBX — Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image
- getImageRBY — Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image
- getImageScale — Returns the adjusting factor to convert pixels to user units.
- getInternalPageNumberAliases — Return an array containing variations for the basic page number alias.
- getLastH — Get the last cell height.
- GetLineWidth — Returns the current the line width.
- getMargins — Returns an array containing current margins: $ret['left'] = left margin $ret['right'] = right margin $ret['top'] = top margin $ret['bottom'] = bottom margin $ret['header'] = header margin $ret['footer'] = footer margin $ret['cell'] = cell padding array $ret['padding_left'] = cell left padding $ret['padding_top'] = cell top padding $ret['padding_right'] = cell right padding $ret['padding_bottom'] = cell bottom padding
- getNumberOfColumns — Return the current number of columns.
- GetNumChars — Returns the numbero of characters in a string.
- getNumLines — This method return the estimated number of lines for print a simple text string using Multicell() method.
- getNumPages — Get the total number of insered pages.
- getOriginalMargins — Returns an array containing original margins: $ret['left'] = left margin $ret['right'] = right margin
- getOverprint — Get the overprint mode array (OP, op, OPM).
- getPage — Get current document page number.
- getPageBuffer — Get page buffer content.
- getPageDimensions — Returns an array of page dimensions: $this->pagedim[$this->page]['w'] = page width in points$this->pagedim[$this->page]['h'] = height in points$this->pagedim[$this->page]['wk'] = page width in user units$this->pagedim[$this->page]['hk'] = page height in user units$this->pagedim[$this->page]['tm'] = top margin$this->pagedim[$this->page]['bm'] = bottom margin$this->pagedim[$this->page]['lm'] = left margin$this->pagedim[$this->page]['rm'] = right margin$this->pagedim[$this->page]['pb'] = auto page break$this->pagedim[$this->page]['or'] = page orientation$this->pagedim[$this->page]['olm'] = original left margin$this->pagedim[$this->page]['orm'] = original right margin$this->pagedim[$this->page]['Rotate'] = The number of degrees by which the page shall be rotated clockwise when displayed or printed. The value shall be a multiple of 90.$this->pagedim[$this->page]['PZ'] = The page's preferred zoom (magnification) factor.$this->pagedim[$this->page]['trans'] : the style and duration of the visual transition to use when moving from another page to the given page during a presentation$this->pagedim[$this->page]['trans']['Dur'] = The page's display duration (also called its advance timing): the maximum length of time, in seconds, that the page shall be displayed during presentations before the viewer application shall automatically advance to the next page.$this->pagedim[$this->page]['trans']['S'] = transition style : Split, Blinds, Box, Wipe, Dissolve, Glitter, R, Fly, Push, Cover, Uncover, Fade$this->pagedim[$this->page]['trans']['D'] = The duration of the transition effect, in seconds.$this->pagedim[$this->page]['trans']['Dm'] = (Split and Blinds transition styles only) The dimension in which the specified transition effect shall occur: H = Horizontal, V = Vertical. Default value: H.$this->pagedim[$this->page]['trans']['M'] = (Split, Box and Fly transition styles only) The direction of motion for the specified transition effect: I = Inward from the edges of the page, O = Outward from the center of the pageDefault value: I.$this->pagedim[$this->page]['trans']['Di'] = (Wipe, Glitter, Fly, Cover, Uncover and Push transition styles only) The direction in which the specified transition effect shall moves, expressed in degrees counterclockwise starting from a left-to-right direction. If the value is a number, it shall be one of: 0 = Left to right, 90 = Bottom to top (Wipe only), 180 = Right to left (Wipe only), 270 = Top to bottom, 315 = Top-left to bottom-right (Glitter only). If the value is a name, it shall be None, which is relevant only for the Fly transition when the value of SS is not 1.0. Default value: 0.$this->pagedim[$this->page]['trans']['SS'] = (Fly transition style only) The starting or ending scale at which the changes shall be drawn. If M specifies an inward transition, the scale of the changes drawn shall progress from SS to 1.0 over the course of the transition. If M specifies an outward transition, the scale of the changes drawn shall progress from 1.0 to SS over the course of the transition. Default: 1.0. $this->pagedim[$this->page]['trans']['B'] = (Fly transition style only) If true, the area that shall be flown in is rectangular and opaque. Default: false.$this->pagedim[$this->page]['MediaBox'] : the boundaries of the physical medium on which the page shall be displayed or printed$this->pagedim[$this->page]['MediaBox']['llx'] = lower-left x coordinate in points$this->pagedim[$this->page]['MediaBox']['lly'] = lower-left y coordinate in points$this->pagedim[$this->page]['MediaBox']['urx'] = upper-right x coordinate in points$this->pagedim[$this->page]['MediaBox']['ury'] = upper-right y coordinate in points$this->pagedim[$this->page]['CropBox'] : the visible region of default user space$this->pagedim[$this->page]['CropBox']['llx'] = lower-left x coordinate in points$this->pagedim[$this->page]['CropBox']['lly'] = lower-left y coordinate in points$this->pagedim[$this->page]['CropBox']['urx'] = upper-right x coordinate in points$this->pagedim[$this->page]['CropBox']['ury'] = upper-right y coordinate in points$this->pagedim[$this->page]['BleedBox'] : the region to which the contents of the page shall be clipped when output in a production environment$this->pagedim[$this->page]['BleedBox']['llx'] = lower-left x coordinate in points$this->pagedim[$this->page]['BleedBox']['lly'] = lower-left y coordinate in points$this->pagedim[$this->page]['BleedBox']['urx'] = upper-right x coordinate in points$this->pagedim[$this->page]['BleedBox']['ury'] = upper-right y coordinate in points$this->pagedim[$this->page]['TrimBox'] : the intended dimensions of the finished page after trimming$this->pagedim[$this->page]['TrimBox']['llx'] = lower-left x coordinate in points$this->pagedim[$this->page]['TrimBox']['lly'] = lower-left y coordinate in points$this->pagedim[$this->page]['TrimBox']['urx'] = upper-right x coordinate in points$this->pagedim[$this->page]['TrimBox']['ury'] = upper-right y coordinate in points$this->pagedim[$this->page]['ArtBox'] : the extent of the page's meaningful content$this->pagedim[$this->page]['ArtBox']['llx'] = lower-left x coordinate in points$this->pagedim[$this->page]['ArtBox']['lly'] = lower-left y coordinate in points$this->pagedim[$this->page]['ArtBox']['urx'] = upper-right x coordinate in points$this->pagedim[$this->page]['ArtBox']['ury'] = upper-right y coordinate in points
- getPageGroupAlias — Return the alias for the total number of pages in the current page group.
- getPageHeight — Returns the page height in units.
- getPageNumGroupAlias — Return the alias for the page number on the current page group.
- getPageRegions — Return an array of no-write page regions
- getPageWidth — Returns the page width in units.
- getPDFData — Returns the PDF data.
- getRawCharWidth — Returns the length of the char in user unit for the current font.
- getRemainingWidth — Returns the remaining width between the current position and margins.
- getRTL — Return the RTL status
- getScaleFactor — Returns the scale factor (number of points in user unit).
- getSignatureAppearanceArray — Get the array that defines the signature appearance (page and rectangle coordinates).
- getSpaceString — Returns the string used to find spaces
- getStringHeight — This method return the estimated height needed for printing a simple text string using the Multicell() method.
- GetStringWidth — Returns the length of a string in user unit. A font must be selected.
- getTextShadow — Return the text shadow parameters array.
- GetX — Returns the relative X value of current position.
- GetY — Returns the ordinate of the current position.
- Gradient — Output gradient.
- Header — This method is used to render the page header.
- hyphenateText — Returns text with soft hyphens.
- hyphenateWord — Returns an array of chars containing soft hyphens.
- Image — Puts an image in the page.
- ImageEps — Embed vector-based Adobe Illustrator (AI) or AI-compatible EPS files.
- ImagePngAlpha — Extract info from a PNG image with alpha channel using the Imagick or GD library.
- ImageSVG — Embedd a Scalable Vector Graphics (SVG) image.
- IncludeJS — Adds a javascript
- inPageBody — Check if we are on the page body (excluding page header and footer).
- isCharDefined — Return true in the character is present in the specified font.
- isRTLTextDir — Return the current temporary RTL status
- isUnicodeFont — Return true if the current font is unicode type.
- lastPage — Reset pointer to the last document page.
- Line — Draws a line between two points.
- LinearGradient — Paints a linear colour gradient.
- Link — Puts a link on a rectangular area of the page.
- ListBox — Creates a List-box field
- Ln — Performs a line break.
- MirrorH — Horizontal Mirroring.
- MirrorL — Reflection against a straight line through point (x, y) with the gradient angle (angle).
- MirrorP — Point reflection mirroring.
- MirrorV — Verical Mirroring.
- movePage — Move a page to a previous position.
- MultiCell — This method allows printing text with line breaks.
- Open — This method begins the generation of the PDF document.
- openHTMLTagHandler — Process opening tags.
- Output — Send the document to a given destination: string, local file or browser.
- PageNo — Returns the current page number.
- PageNoFormatted — Returns the current page number formatted as a string.
- PieSector — Draw the sector of a circle.
- PieSectorXY — Draw the sector of an ellipse.
- pixelsToUnits — Converts pixels to User's Units.
- Polycurve — Draws a poly-Bezier curve.
- Polygon — Draws a polygon.
- PolyLine — Draws a polygonal line
- printTemplate — Print an XObject Template.
- putHtmlListBullet — Output an HTML list bullet or ordered item symbol
- RadialGradient — Paints a radial colour gradient.
- RadioButton — Creates a RadioButton field.
- Rect — Draws a rectangle.
- registrationMark — Paints a registration mark
- registrationMarkCMYK — Paints a CMYK registration mark
- RegularPolygon — Draws a regular polygon.
- removePageRegion — Remove a single no-write region.
- removeTagNamespace — Return the tag name without the namespace
- replaceBuffer — Replace the buffer content
- replaceChar — Replace a char if is defined on the current font.
- replaceMissingChars — Replace missing font characters on selected font with specified substitutions.
- replaceRightShiftPageNumAliases — Replace right shift page number aliases with spaces to correct right alignment.
- resetColumns — Remove columns and reset page margins.
- resetHeaderTemplate — Reset the xobject template used by Header() method.
- resetLastH — Reset the last cell height.
- rollbackTransaction — This method allows to undo the latest transaction by returning the latest saved TCPDF object with startTransaction().
- Rotate — Rotate object.
- RoundedRect — Draws a rounded rectangle.
- RoundedRectXY — Draws a rounded rectangle.
- Scale — Vertical and horizontal non-proportional Scaling.
- ScaleX — Horizontal Scaling.
- ScaleXY — Vertical and horizontal proportional Scaling.
- ScaleY — Vertical Scaling.
- segSVGContentHandler — Sets the character data handler function for the XML parser.
- selectColumn — Set position at a given column
- serializeTCPDFtagParameters — Serialize an array of parameters to be used with TCPDF tag in HTML code.
- SetAbsX — Set the absolute X coordinate of the current pointer.
- SetAbsXY — Set the absolute X and Y coordinates of the current pointer.
- SetAbsY — Set the absolute Y coordinate of the current pointer.
- setAlpha — Set alpha for stroking (CA) and non-stroking (ca) operations.
- SetAuthor — Defines the author of the document.
- 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.
- setBarcode — Set document barcode.
- SetBooklet — Set the booklet mode for double-sided pages.
- setBookmark — Adds a bookmark - alias for Bookmark().
- setBuffer — Set buffer content (always append data).
- setCellHeightRatio — Set the height of the cell (line height) respect the font height.
- setCellMargins — Set the internal Cell margins.
- SetCellPadding — Set the same internal Cell padding for top, right, bottom, left-
- setCellPaddings — Set the internal Cell paddings.
- setColor — Defines the color used by the specified type ('draw', 'fill', 'text').
- setColorArray — Set the color array for the specified type ('draw', 'fill', 'text').
- setColumnsArray — Set columns array.
- 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.
- setContentMark — Set start-writing mark on selected page.
- SetCreator — Defines the creator of the document. This is typically the name of the application that generates the PDF.
- SetDefaultMonospacedFont — Defines the default monospaced font.
- setDefaultTableColumns — Set the default number of columns in a row for HTML tables.
- setDestination — Add a Named Destination.
- SetDisplayMode — Defines the way the document is to be displayed by the viewer.
- setDocCreationTimestamp — Set the document creation timestamp
- SetDocInfoUnicode — Turn on/off Unicode mode for document information dictionary (meta tags).
- setDocModificationTimestamp — Set the document modification timestamp
- 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.
- SetDrawColorArray — Defines the color used for all drawing operations (lines, rectangles and cell borders).
- SetDrawSpotColor — Defines the spot color used for all drawing operations (lines, rectangles and cell borders).
- setEqualColumns — Set multiple columns of the same size
- setExtGState — Add an extgstate
- setExtraXMP — Set additional XMP data to be added on the default XMP data just before the end of "x:xmpmeta" tag.
- setExtraXMPRDF — Set additional XMP data to be added on the default XMP data just before the end of "rdf:RDF" tag.
- 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.
- SetFillColorArray — Defines the color used for all filling operations (filled rectangles and cell backgrounds).
- SetFillSpotColor — Defines the spot color used for all filling operations (filled rectangles and cell backgrounds).
- SetFont — Sets the font used to print character strings.
- setFontBuffer — Set font buffer content.
- SetFontSize — Defines the size of the current font.
- setFontSpacing — Set the amount to increase or decrease the space between characters in a text.
- setFontStretching — Set the percentage of character stretching.
- setFontSubBuffer — Set font buffer content.
- setFontSubsetting — Enable or disable default option for font subsetting.
- setFooter — This method is used to render the page footer.
- setFooterData — Set footer data.
- setFooterFont — Set footer font.
- setFooterMargin — Set footer margin.
- setFormDefaultProp — Set default properties for form fields.
- setGraphicVars — Set graphic variables.
- setHeader — This method is used to render the page header.
- setHeaderData — Set header data.
- setHeaderFont — Set header font.
- setHeaderMargin — Set header margin.
- setHeaderTemplateAutoreset — Set a flag to automatically reset the xobject template used by Header() method at each page.
- setHtmlLinksStyle — Set the color and font style for HTML links.
- setHtmlVSpace — Set the vertical spaces for HTML tags.
- setImageBuffer — Set image buffer content.
- setImageScale — Set the adjusting factor to convert pixels to user units.
- setImageSubBuffer — Set image buffer content for a specified sub-key.
- setJPEGQuality — Set the default JPEG compression quality (1-100)
- SetKeywords — Associates keywords with the document, generally in the form 'keyword1 keyword2 .
- setLanguageArray — Set language array.
- setLastH — Set the last cell height.
- 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.
- SetLineStyle — Set line style.
- 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.
- SetLink — Defines the page and position a link points to.
- setListIndentWidth — Set custom width for list indentation.
- setLIsymbol — Set the default bullet to be used as LI bullet symbol
- SetMargins — Defines the left, top and right margins.
- setOpenCell — Set the top/bottom cell sides to be open or closed when the cell cross the page.
- setOverprint — Set overprint mode for stroking (OP) and non-stroking (op) painting operations.
- setPage — Move pointer at the specified document page and update page dimensions.
- setPageBoxTypes — Set page boxes to be included on page descriptions.
- setPageBuffer — Set page buffer content.
- setPageFormat — Change the format of the current page
- setPageMark — Set start-writing mark on current page stream used to put borders and fills.
- setPageOrientation — Set page orientation.
- setPageRegions — Set no-write regions on page.
- setPageUnit — Set the units of measure for the document.
- setPDFVersion — Set the PDF version (check PDF reference for valid values).
- setPrintFooter — Set a flag to print page footer.
- setPrintHeader — Set a flag to print page header.
- SetProtection — Set document protection Remark: the protection against modification is for people who have the full Acrobat product.
- setRasterizeVectorImages — Enable/disable rasterization of vector images using ImageMagick library.
- SetRightMargin — Defines the right margin. The method can be called before creating the first page.
- setRTL — Enable or disable Right-To-Left language mode
- setSignature — Enable document signature (requires the OpenSSL Library).
- setSignatureAppearance — Set the digital signature appearance (a cliccable rectangle area to get signature properties)
- setSpacesRE — Set regular expression to detect withespaces or word separators.
- setSpotColor — Set the spot color for the specified type ('draw', 'fill', 'text').
- setSRGBmode — Set flag to force sRGB_IEC61966-2.1 black scaled ICC color profile for the whole document.
- setStartingPageNumber — Set the starting page number.
- SetSubject — Defines the subject of the document.
- setSVGStyles — Apply the requested SVG styles (*** TO BE COMPLETED ***)
- setTableHeader — This method is used to render the table header on new page (if any).
- setTempRTL — Force temporary RTL language direction
- 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.
- SetTextColorArray — Defines the color used for text. It can be expressed in RGB components or gray scale.
- setTextRenderingMode — Set Text rendering mode.
- setTextShadow — Set parameters for drop shadow effect for text.
- SetTextSpotColor — Defines the spot color used for text.
- setTimeStamp — Enable document timestamping (requires the OpenSSL Library).
- SetTitle — Defines the title of the document.
- SetTopMargin — Defines the top margin. The method can be called before creating the first page.
- setUserRights — Set User's Rights for PDF Reader WARNING: This is experimental and currently do not work.
- setViewerPreferences — Set the viewer preferences dictionary controlling the way the document is to be presented on the screen or in print.
- setVisibility — Set the visibility of the successive elements.
- SetX — Defines the abscissa of the current position.
- SetXY — Defines the abscissa and ordinate of the current position.
- SetY — Moves the current abscissa back to the left margin and sets the ordinate.
- Skew — Skew.
- SkewX — Skew horizontally.
- SkewY — Skew vertically.
- sortBookmarks — Sort bookmarks for page and key.
- StarPolygon — Draws a star polygon
- startLayer — Start a new pdf layer.
- startPage — Starts a new page to the document. The page must be closed using the endPage() function.
- startPageGroup — Create a new page group.
- startSVGElementHandler — Sets the opening SVG element handler function for the XML parser. (*** TO BE COMPLETED ***)
- startTemplate — Start a new XObject Template.
- startTransaction — Stores a copy of the current TCPDF object used for undo operation.
- StartTransform — Starts a 2D tranformation saving current graphic state.
- StopTransform — Stops a 2D tranformation restoring previous graphic state.
- stringLeftTrim — Left trim the input string
- stringRightTrim — Right trim the input string
- stringTrim — Trim the input string
- SVGPath — Draws an SVG path
- SVGTransform — Apply SVG graphic transformation matrix.
- swapMargins — Swap the left and right margins.
- Text — Prints a text cell at the specified position.
- TextField — Creates a text field
- Transform — Apply graphic transformations.
- Translate — Translate graphic object horizontally and vertically.
- TranslateX — Translate graphic object horizontally.
- TranslateY — Translate graphic object vertically.
- unhtmlentities — Reverse function for htmlentities.
- unserializeTCPDFtagParameters — Unserialize parameters to be used with TCPDF tag in HTML code.
- Write — This method prints text from the current position.
- write1DBarcode — Print a Linear Barcode.
- write2DBarcode — Print 2D Barcode.
- 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.
- writeHTMLCell — Prints a cell (rectangular area) with optional borders, background color and html text string.