Method: TCPDF#startPage

Defined in:

lib/tcpdf.rb

#startPage(orientation = '', format = '', tocpage = false) ⇒ Object Also known as: start_page

Starts a new page to the document. The page must be closed using the endPage() function. The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.

@param string :orientation

page orientation. Possible values are (case insensitive):

• P or PORTRAIT (default)

• L or LANDSCAPE

@param mixed :format

The format used for pages. It can be either: A string indicating the page format:

• 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

An array containing page measures and advanced options: see setPageFormat()

@param boolean :tocpage

if true set the tocpage state to true (the added page will be used to display Table of Content).

@access public

@since 4.2.010 (2008-11-14)

@see

AddPage(), endPage(), addTOCPage(), endTOCPage()

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

def startPage(orientation='', format='', tocpage=false)
  if tocpage
    @tocpage = true
  end
  if @numpages > @page
    # this page has been already added
    setPage(@page + 1)
    SetY(@t_margin)
    return
  end
  # start a new page
  if @state == 0
    Open()
  end
  @numpages += 1
  swapMargins(@booklet)
  # save current graphic settings
  gvars = getGraphicVars()
  # start new page
  beginpage(orientation, format)
  # mark page as open
  @pageopen[@page] = true
  # restore graphic settings
  setGraphicVars(gvars)
  # mark this point
  setPageMark()
  # print page header
  setHeader()
  # restore graphic settings
  setGraphicVars(gvars)
  # mark this point
  setPageMark()
  # print table header (if any)
  setTableHeader()
end