Method: TCPDF#AddPage

Defined in:

lib/tcpdf.rb

#AddPage(orientation = '', format = '', keepmargins = false, tocpage = false) ⇒ Object Also known as: add_page

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). The origin of the coordinate system is at the top-left corner (or top-right for RTL) 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 :keepmargins

if true overwrites the default page margins with the current margin

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

@see

startPage, endPage(), addTOCPage(), endTOCPage()

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

def AddPage(orientation='', format='', keepmargins=false, tocpage=false)
  if @original_l_margin.nil? or keepmargins
    @original_l_margin = @l_margin
  end
  if @original_r_margin.nil? or keepmargins
    @original_r_margin = @r_margin
  end
  # terminate previous page
  endPage()
  # start new page
  startPage(orientation, format, tocpage)
end