Method: TCPDF#Text

Defined in:

lib/tcpdf.rb

#Text(x, y, txt, fstroke = false, fclip = false, ffill = true, border = 0, ln = 0, align = '', fill = 0, link = '', stretch = 0, ignore_min_height = false, calign = 'T', valign = 'M', rtloff = false) ⇒ Object Also known as: text

Prints a text cell at the specified position. The origin is on the left of the first charcter, on the baseline. This method allows to place a string precisely on the page.

@param float :x

Abscissa of the cell origin

@param float :y

Ordinate of the cell origin

@param string :txt

String to print

@param int :fstroke

outline size in user units (false = disable)

@param boolean :fclip

if true activate clipping mode (you must call StartTransform() before this function and StopTransform() to stop the clipping tranformation).

@param boolean :ffill

if true fills the text

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

@param int :ln

Indicates where the current position should go after the call. Possible values are:

• 0: to the right (or left for RTL languages)

• 1: to the beginning of the next line

• 2: below

Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.

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

• J: justify

@param int :fill

Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.

@param mixed :link

URL or identifier returned by AddLink().

@param int :stretch

stretch carachter mode:

• 0 = disabled

• 1 = horizontal scaling only if necessary

• 2 = forced horizontal scaling

• 3 = character spacing only if necessary

• 4 = forced character spacing

@param boolean :ignore_min_height

if true ignore automatic minimum height value.

@param string :calign

cell vertical alignment relative to the specified Y value. Possible values are:

• T : cell top

• A : font top

• L : font baseline

• D : font bottom

• B : cell bottom

@param string :valign

text vertical alignment inside the cell. Possible values are:

• T : top

• C : center

• B : bottom

@param boolean :rtloff

if true uses the page top-left corner as origin of axis for :x and :y initial position.

@access public

@since 1.0

@see

SetFont(), SetTextColor(), Cell(), MultiCell(), Write()

# File 'lib/tcpdf.rb', line 3108

def Text(x, y, txt, fstroke=false, fclip=false, ffill=true, border=0, ln=0, align='', fill=0, link='', stretch=0, ignore_min_height=false, calign='T', valign='M', rtloff=false)
  fstroke = 0 if fstroke == false

  textrendermode = @textrendermode
  textstrokewidth = @textstrokewidth
  setTextRenderingMode(fstroke, ffill, fclip)
  SetXY(x, y, rtloff)
  Cell(0, 0, txt, border, ln, align, fill, link, stretch, ignore_min_height, calign, valign)
  # restore previous rendering mode
  @textrendermode = textrendermode
  @textstrokewidth = textstrokewidth
end