\PhpOffice\PhpSpreadsheet\WorksheetPageSetup

<code> Paper size taken from Office Open XML Part 4 - Markup Language Reference, page 1988:.

1 = Letter paper (8.5 in. by 11 in.) 2 = Letter small paper (8.5 in. by 11 in.) 3 = Tabloid paper (11 in. by 17 in.) 4 = Ledger paper (17 in. by 11 in.) 5 = Legal paper (8.5 in. by 14 in.) 6 = Statement paper (5.5 in. by 8.5 in.) 7 = Executive paper (7.25 in. by 10.5 in.) 8 = A3 paper (297 mm by 420 mm) 9 = A4 paper (210 mm by 297 mm) 10 = A4 small paper (210 mm by 297 mm) 11 = A5 paper (148 mm by 210 mm) 12 = B4 paper (250 mm by 353 mm) 13 = B5 paper (176 mm by 250 mm) 14 = Folio paper (8.5 in. by 13 in.) 15 = Quarto paper (215 mm by 275 mm) 16 = Standard paper (10 in. by 14 in.) 17 = Standard paper (11 in. by 17 in.) 18 = Note paper (8.5 in. by 11 in.) 19 = #9 envelope (3.875 in. by 8.875 in.) 20 = #10 envelope (4.125 in. by 9.5 in.) 21 = #11 envelope (4.5 in. by 10.375 in.) 22 = #12 envelope (4.75 in. by 11 in.) 23 = #14 envelope (5 in. by 11.5 in.) 24 = C paper (17 in. by 22 in.) 25 = D paper (22 in. by 34 in.) 26 = E paper (34 in. by 44 in.) 27 = DL envelope (110 mm by 220 mm) 28 = C5 envelope (162 mm by 229 mm) 29 = C3 envelope (324 mm by 458 mm) 30 = C4 envelope (229 mm by 324 mm) 31 = C6 envelope (114 mm by 162 mm) 32 = C65 envelope (114 mm by 229 mm) 33 = B4 envelope (250 mm by 353 mm) 34 = B5 envelope (176 mm by 250 mm) 35 = B6 envelope (176 mm by 125 mm) 36 = Italy envelope (110 mm by 230 mm) 37 = Monarch envelope (3.875 in. by 7.5 in.). 38 = 6 3/4 envelope (3.625 in. by 6.5 in.) 39 = US standard fanfold (14.875 in. by 11 in.) 40 = German standard fanfold (8.5 in. by 12 in.) 41 = German legal fanfold (8.5 in. by 13 in.) 42 = ISO B4 (250 mm by 353 mm) 43 = Japanese double postcard (200 mm by 148 mm) 44 = Standard paper (9 in. by 11 in.) 45 = Standard paper (10 in. by 11 in.) 46 = Standard paper (15 in. by 11 in.) 47 = Invite envelope (220 mm by 220 mm) 50 = Letter extra paper (9.275 in. by 12 in.) 51 = Legal extra paper (9.275 in. by 15 in.) 52 = Tabloid extra paper (11.69 in. by 18 in.) 53 = A4 extra paper (236 mm by 322 mm) 54 = Letter transverse paper (8.275 in. by 11 in.) 55 = A4 transverse paper (210 mm by 297 mm) 56 = Letter extra transverse paper (9.275 in. by 12 in.) 57 = SuperA/SuperA/A4 paper (227 mm by 356 mm) 58 = SuperB/SuperB/A3 paper (305 mm by 487 mm) 59 = Letter plus paper (8.5 in. by 12.69 in.) 60 = A4 plus paper (210 mm by 330 mm) 61 = A5 transverse paper (148 mm by 210 mm) 62 = JIS B5 transverse paper (182 mm by 257 mm) 63 = A3 extra paper (322 mm by 445 mm) 64 = A5 extra paper (174 mm by 235 mm) 65 = ISO B5 extra paper (201 mm by 276 mm) 66 = A2 paper (420 mm by 594 mm) 67 = A3 transverse paper (297 mm by 420 mm) 68 = A3 extra transverse paper (322 mm by 445 mm)

Summary

Methods
Properties
Constants
__construct()
getPaperSize()
setPaperSize()
getOrientation()
setOrientation()
getScale()
setScale()
getFitToPage()
setFitToPage()
getFitToHeight()
setFitToHeight()
getFitToWidth()
setFitToWidth()
isColumnsToRepeatAtLeftSet()
getColumnsToRepeatAtLeft()
setColumnsToRepeatAtLeft()
setColumnsToRepeatAtLeftByStartAndEnd()
isRowsToRepeatAtTopSet()
getRowsToRepeatAtTop()
setRowsToRepeatAtTop()
setRowsToRepeatAtTopByStartAndEnd()
getHorizontalCentered()
setHorizontalCentered()
getVerticalCentered()
setVerticalCentered()
getPrintArea()
isPrintAreaSet()
clearPrintArea()
setPrintArea()
addPrintArea()
setPrintAreaByColumnAndRow()
addPrintAreaByColumnAndRow()
getFirstPageNumber()
setFirstPageNumber()
resetFirstPageNumber()
__clone()
No public properties found
PAPERSIZE_LETTER
PAPERSIZE_LETTER_SMALL
PAPERSIZE_TABLOID
PAPERSIZE_LEDGER
PAPERSIZE_LEGAL
PAPERSIZE_STATEMENT
PAPERSIZE_EXECUTIVE
PAPERSIZE_A3
PAPERSIZE_A4
PAPERSIZE_A4_SMALL
PAPERSIZE_A5
PAPERSIZE_B4
PAPERSIZE_B5
PAPERSIZE_FOLIO
PAPERSIZE_QUARTO
PAPERSIZE_STANDARD_1
PAPERSIZE_STANDARD_2
PAPERSIZE_NOTE
PAPERSIZE_NO9_ENVELOPE
PAPERSIZE_NO10_ENVELOPE
PAPERSIZE_NO11_ENVELOPE
PAPERSIZE_NO12_ENVELOPE
PAPERSIZE_NO14_ENVELOPE
PAPERSIZE_C
PAPERSIZE_D
PAPERSIZE_E
PAPERSIZE_DL_ENVELOPE
PAPERSIZE_C5_ENVELOPE
PAPERSIZE_C3_ENVELOPE
PAPERSIZE_C4_ENVELOPE
PAPERSIZE_C6_ENVELOPE
PAPERSIZE_C65_ENVELOPE
PAPERSIZE_B4_ENVELOPE
PAPERSIZE_B5_ENVELOPE
PAPERSIZE_B6_ENVELOPE
PAPERSIZE_ITALY_ENVELOPE
PAPERSIZE_MONARCH_ENVELOPE
PAPERSIZE_6_3_4_ENVELOPE
PAPERSIZE_US_STANDARD_FANFOLD
PAPERSIZE_GERMAN_STANDARD_FANFOLD
PAPERSIZE_GERMAN_LEGAL_FANFOLD
PAPERSIZE_ISO_B4
PAPERSIZE_JAPANESE_DOUBLE_POSTCARD
PAPERSIZE_STANDARD_PAPER_1
PAPERSIZE_STANDARD_PAPER_2
PAPERSIZE_STANDARD_PAPER_3
PAPERSIZE_INVITE_ENVELOPE
PAPERSIZE_LETTER_EXTRA_PAPER
PAPERSIZE_LEGAL_EXTRA_PAPER
PAPERSIZE_TABLOID_EXTRA_PAPER
PAPERSIZE_A4_EXTRA_PAPER
PAPERSIZE_LETTER_TRANSVERSE_PAPER
PAPERSIZE_A4_TRANSVERSE_PAPER
PAPERSIZE_LETTER_EXTRA_TRANSVERSE_PAPER
PAPERSIZE_SUPERA_SUPERA_A4_PAPER
PAPERSIZE_SUPERB_SUPERB_A3_PAPER
PAPERSIZE_LETTER_PLUS_PAPER
PAPERSIZE_A4_PLUS_PAPER
PAPERSIZE_A5_TRANSVERSE_PAPER
PAPERSIZE_JIS_B5_TRANSVERSE_PAPER
PAPERSIZE_A3_EXTRA_PAPER
PAPERSIZE_A5_EXTRA_PAPER
PAPERSIZE_ISO_B5_EXTRA_PAPER
PAPERSIZE_A2_PAPER
PAPERSIZE_A3_TRANSVERSE_PAPER
PAPERSIZE_A3_EXTRA_TRANSVERSE_PAPER
ORIENTATION_DEFAULT
ORIENTATION_LANDSCAPE
ORIENTATION_PORTRAIT
SETPRINTRANGE_OVERWRITE
SETPRINTRANGE_INSERT
No protected methods found
No protected properties found
N/A
No private methods found
$paperSize
$orientation
$scale
$fitToPage
$fitToHeight
$fitToWidth
$columnsToRepeatAtLeft
$rowsToRepeatAtTop
$horizontalCentered
$verticalCentered
$printArea
$firstPageNumber
N/A

Constants

PAPERSIZE_LETTER

PAPERSIZE_LETTER = 1

PAPERSIZE_LETTER_SMALL

PAPERSIZE_LETTER_SMALL = 2

PAPERSIZE_TABLOID

PAPERSIZE_TABLOID = 3

PAPERSIZE_LEDGER

PAPERSIZE_LEDGER = 4

PAPERSIZE_STATEMENT

PAPERSIZE_STATEMENT = 6

PAPERSIZE_EXECUTIVE

PAPERSIZE_EXECUTIVE = 7

PAPERSIZE_A3

PAPERSIZE_A3 = 8

PAPERSIZE_A4

PAPERSIZE_A4 = 9

PAPERSIZE_A4_SMALL

PAPERSIZE_A4_SMALL = 10

PAPERSIZE_A5

PAPERSIZE_A5 = 11

PAPERSIZE_B4

PAPERSIZE_B4 = 12

PAPERSIZE_B5

PAPERSIZE_B5 = 13

PAPERSIZE_FOLIO

PAPERSIZE_FOLIO = 14

PAPERSIZE_QUARTO

PAPERSIZE_QUARTO = 15

PAPERSIZE_STANDARD_1

PAPERSIZE_STANDARD_1 = 16

PAPERSIZE_STANDARD_2

PAPERSIZE_STANDARD_2 = 17

PAPERSIZE_NOTE

PAPERSIZE_NOTE = 18

PAPERSIZE_NO9_ENVELOPE

PAPERSIZE_NO9_ENVELOPE = 19

PAPERSIZE_NO10_ENVELOPE

PAPERSIZE_NO10_ENVELOPE = 20

PAPERSIZE_NO11_ENVELOPE

PAPERSIZE_NO11_ENVELOPE = 21

PAPERSIZE_NO12_ENVELOPE

PAPERSIZE_NO12_ENVELOPE = 22

PAPERSIZE_NO14_ENVELOPE

PAPERSIZE_NO14_ENVELOPE = 23

PAPERSIZE_C

PAPERSIZE_C = 24

PAPERSIZE_D

PAPERSIZE_D = 25

PAPERSIZE_E

PAPERSIZE_E = 26

PAPERSIZE_DL_ENVELOPE

PAPERSIZE_DL_ENVELOPE = 27

PAPERSIZE_C5_ENVELOPE

PAPERSIZE_C5_ENVELOPE = 28

PAPERSIZE_C3_ENVELOPE

PAPERSIZE_C3_ENVELOPE = 29

PAPERSIZE_C4_ENVELOPE

PAPERSIZE_C4_ENVELOPE = 30

PAPERSIZE_C6_ENVELOPE

PAPERSIZE_C6_ENVELOPE = 31

PAPERSIZE_C65_ENVELOPE

PAPERSIZE_C65_ENVELOPE = 32

PAPERSIZE_B4_ENVELOPE

PAPERSIZE_B4_ENVELOPE = 33

PAPERSIZE_B5_ENVELOPE

PAPERSIZE_B5_ENVELOPE = 34

PAPERSIZE_B6_ENVELOPE

PAPERSIZE_B6_ENVELOPE = 35

PAPERSIZE_ITALY_ENVELOPE

PAPERSIZE_ITALY_ENVELOPE = 36

PAPERSIZE_MONARCH_ENVELOPE

PAPERSIZE_MONARCH_ENVELOPE = 37

PAPERSIZE_6_3_4_ENVELOPE

PAPERSIZE_6_3_4_ENVELOPE = 38

PAPERSIZE_US_STANDARD_FANFOLD

PAPERSIZE_US_STANDARD_FANFOLD = 39

PAPERSIZE_GERMAN_STANDARD_FANFOLD

PAPERSIZE_GERMAN_STANDARD_FANFOLD = 40

PAPERSIZE_ISO_B4

PAPERSIZE_ISO_B4 = 42

PAPERSIZE_JAPANESE_DOUBLE_POSTCARD

PAPERSIZE_JAPANESE_DOUBLE_POSTCARD = 43

PAPERSIZE_STANDARD_PAPER_1

PAPERSIZE_STANDARD_PAPER_1 = 44

PAPERSIZE_STANDARD_PAPER_2

PAPERSIZE_STANDARD_PAPER_2 = 45

PAPERSIZE_STANDARD_PAPER_3

PAPERSIZE_STANDARD_PAPER_3 = 46

PAPERSIZE_INVITE_ENVELOPE

PAPERSIZE_INVITE_ENVELOPE = 47

PAPERSIZE_LETTER_EXTRA_PAPER

PAPERSIZE_LETTER_EXTRA_PAPER = 48

PAPERSIZE_TABLOID_EXTRA_PAPER

PAPERSIZE_TABLOID_EXTRA_PAPER = 50

PAPERSIZE_A4_EXTRA_PAPER

PAPERSIZE_A4_EXTRA_PAPER = 51

PAPERSIZE_LETTER_TRANSVERSE_PAPER

PAPERSIZE_LETTER_TRANSVERSE_PAPER = 52

PAPERSIZE_A4_TRANSVERSE_PAPER

PAPERSIZE_A4_TRANSVERSE_PAPER = 53

PAPERSIZE_LETTER_EXTRA_TRANSVERSE_PAPER

PAPERSIZE_LETTER_EXTRA_TRANSVERSE_PAPER = 54

PAPERSIZE_SUPERA_SUPERA_A4_PAPER

PAPERSIZE_SUPERA_SUPERA_A4_PAPER = 55

PAPERSIZE_SUPERB_SUPERB_A3_PAPER

PAPERSIZE_SUPERB_SUPERB_A3_PAPER = 56

PAPERSIZE_LETTER_PLUS_PAPER

PAPERSIZE_LETTER_PLUS_PAPER = 57

PAPERSIZE_A4_PLUS_PAPER

PAPERSIZE_A4_PLUS_PAPER = 58

PAPERSIZE_A5_TRANSVERSE_PAPER

PAPERSIZE_A5_TRANSVERSE_PAPER = 59

PAPERSIZE_JIS_B5_TRANSVERSE_PAPER

PAPERSIZE_JIS_B5_TRANSVERSE_PAPER = 60

PAPERSIZE_A3_EXTRA_PAPER

PAPERSIZE_A3_EXTRA_PAPER = 61

PAPERSIZE_A5_EXTRA_PAPER

PAPERSIZE_A5_EXTRA_PAPER = 62

PAPERSIZE_ISO_B5_EXTRA_PAPER

PAPERSIZE_ISO_B5_EXTRA_PAPER = 63

PAPERSIZE_A2_PAPER

PAPERSIZE_A2_PAPER = 64

PAPERSIZE_A3_TRANSVERSE_PAPER

PAPERSIZE_A3_TRANSVERSE_PAPER = 65

PAPERSIZE_A3_EXTRA_TRANSVERSE_PAPER

PAPERSIZE_A3_EXTRA_TRANSVERSE_PAPER = 66

ORIENTATION_DEFAULT

ORIENTATION_DEFAULT = 'default'

ORIENTATION_LANDSCAPE

ORIENTATION_LANDSCAPE = 'landscape'

ORIENTATION_PORTRAIT

ORIENTATION_PORTRAIT = 'portrait'

SETPRINTRANGE_OVERWRITE

SETPRINTRANGE_OVERWRITE = 'O'

SETPRINTRANGE_INSERT

SETPRINTRANGE_INSERT = 'I'

Properties

$paperSize

$paperSize : integer

Paper size.

Type

integer

$orientation

$orientation : string

Orientation.

Type

string

$scale

$scale : \PhpOffice\PhpSpreadsheet\Worksheet\int?

Scale (Print Scale).

Print scaling. Valid values range from 10 to 400 This setting is overridden when fitToWidth and/or fitToHeight are in use

Type

\PhpOffice\PhpSpreadsheet\Worksheet\int?

$fitToPage

$fitToPage : boolean

Fit To Page Whether scale or fitToWith / fitToHeight applies.

Type

boolean

$fitToHeight

$fitToHeight : \PhpOffice\PhpSpreadsheet\Worksheet\int?

Fit To Height Number of vertical pages to fit on.

Type

\PhpOffice\PhpSpreadsheet\Worksheet\int?

$fitToWidth

$fitToWidth : \PhpOffice\PhpSpreadsheet\Worksheet\int?

Fit To Width Number of horizontal pages to fit on.

Type

\PhpOffice\PhpSpreadsheet\Worksheet\int?

$columnsToRepeatAtLeft

$columnsToRepeatAtLeft : array

Columns to repeat at left.

Type

array — Containing start column and end column, empty array if option unset

$rowsToRepeatAtTop

$rowsToRepeatAtTop : array

Rows to repeat at top.

Type

array — Containing start row number and end row number, empty array if option unset

$horizontalCentered

$horizontalCentered : boolean

Center page horizontally.

Type

boolean

$verticalCentered

$verticalCentered : boolean

Center page vertically.

Type

boolean

$printArea

$printArea : string

Print area.

Type

string

$firstPageNumber

$firstPageNumber : integer

First page number.

Type

integer

Methods

__construct()

__construct() 

Create a new PageSetup.

getPaperSize()

getPaperSize() : integer

Get Paper Size.

Returns

integer

setPaperSize()

setPaperSize(integer  $pValue) : $this

Set Paper Size.

Parameters

integer $pValue

see self::PAPERSIZE_*

Returns

$this

getOrientation()

getOrientation() : string

Get Orientation.

Returns

string

setOrientation()

setOrientation(string  $pValue) : $this

Set Orientation.

Parameters

string $pValue

see self::ORIENTATION_*

Returns

$this

getScale()

getScale() : \PhpOffice\PhpSpreadsheet\Worksheet\int?

Get Scale.

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\int?

setScale()

setScale(null|integer  $pValue, boolean  $pUpdate = true) : $this

Set Scale.

Print scaling. Valid values range from 10 to 400 This setting is overridden when fitToWidth and/or fitToHeight are in use.

Parameters

null|integer $pValue
boolean $pUpdate

Update fitToPage so scaling applies rather than fitToHeight / fitToWidth

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

$this

getFitToPage()

getFitToPage() : boolean

Get Fit To Page.

Returns

boolean

setFitToPage()

setFitToPage(boolean  $pValue) : $this

Set Fit To Page.

Parameters

boolean $pValue

Returns

$this

getFitToHeight()

getFitToHeight() : \PhpOffice\PhpSpreadsheet\Worksheet\int?

Get Fit To Height.

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\int?

setFitToHeight()

setFitToHeight(null|integer  $pValue, boolean  $pUpdate = true) : $this

Set Fit To Height.

Parameters

null|integer $pValue
boolean $pUpdate

Update fitToPage so it applies rather than scaling

Returns

$this

getFitToWidth()

getFitToWidth() : \PhpOffice\PhpSpreadsheet\Worksheet\int?

Get Fit To Width.

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\int?

setFitToWidth()

setFitToWidth(null|integer  $pValue, boolean  $pUpdate = true) : $this

Set Fit To Width.

Parameters

null|integer $pValue
boolean $pUpdate

Update fitToPage so it applies rather than scaling

Returns

$this

isColumnsToRepeatAtLeftSet()

isColumnsToRepeatAtLeftSet() : boolean

Is Columns to repeat at left set?

Returns

boolean

getColumnsToRepeatAtLeft()

getColumnsToRepeatAtLeft() : array

Get Columns to repeat at left.

Returns

array —

Containing start column and end column, empty array if option unset

setColumnsToRepeatAtLeft()

setColumnsToRepeatAtLeft(array  $pValue) : $this

Set Columns to repeat at left.

Parameters

array $pValue

Containing start column and end column, empty array if option unset

Returns

$this

setColumnsToRepeatAtLeftByStartAndEnd()

setColumnsToRepeatAtLeftByStartAndEnd(string  $pStart, string  $pEnd) : $this

Set Columns to repeat at left by start and end.

Parameters

string $pStart

eg: 'A'

string $pEnd

eg: 'B'

Returns

$this

isRowsToRepeatAtTopSet()

isRowsToRepeatAtTopSet() : boolean

Is Rows to repeat at top set?

Returns

boolean

getRowsToRepeatAtTop()

getRowsToRepeatAtTop() : array

Get Rows to repeat at top.

Returns

array —

Containing start column and end column, empty array if option unset

setRowsToRepeatAtTop()

setRowsToRepeatAtTop(array  $pValue) : $this

Set Rows to repeat at top.

Parameters

array $pValue

Containing start column and end column, empty array if option unset

Returns

$this

setRowsToRepeatAtTopByStartAndEnd()

setRowsToRepeatAtTopByStartAndEnd(integer  $pStart, integer  $pEnd) : $this

Set Rows to repeat at top by start and end.

Parameters

integer $pStart

eg: 1

integer $pEnd

eg: 1

Returns

$this

getHorizontalCentered()

getHorizontalCentered() : boolean

Get center page horizontally.

Returns

boolean

setHorizontalCentered()

setHorizontalCentered(boolean  $value) : $this

Set center page horizontally.

Parameters

boolean $value

Returns

$this

getVerticalCentered()

getVerticalCentered() : boolean

Get center page vertically.

Returns

boolean

setVerticalCentered()

setVerticalCentered(boolean  $value) : $this

Set center page vertically.

Parameters

boolean $value

Returns

$this

getPrintArea()

getPrintArea(integer  $index) : string

Get print area.

Parameters

integer $index

Identifier for a specific print area range if several ranges have been set Default behaviour, or a index value of 0, will return all ranges as a comma-separated string Otherwise, the specific range identified by the value of $index will be returned Print areas are numbered from 1

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

string

isPrintAreaSet()

isPrintAreaSet(integer  $index) : boolean

Is print area set?

Parameters

integer $index

Identifier for a specific print area range if several ranges have been set Default behaviour, or an index value of 0, will identify whether any print range is set Otherwise, existence of the range identified by the value of $index will be returned Print areas are numbered from 1

Returns

boolean

clearPrintArea()

clearPrintArea(integer  $index) : $this

Clear a print area.

Parameters

integer $index

Identifier for a specific print area range if several ranges have been set Default behaviour, or an index value of 0, will clear all print ranges that are set Otherwise, the range identified by the value of $index will be removed from the series Print areas are numbered from 1

Returns

$this

setPrintArea()

setPrintArea(string  $value, integer  $index, string  $method = self::SETPRINTRANGE_OVERWRITE) : $this

Set print area. e.g. 'A1:D10' or 'A1:D10,G5:M20'.

Parameters

string $value
integer $index

Identifier for a specific print area range allowing several ranges to be set When the method is "O"verwrite, then a positive integer index will overwrite that indexed entry in the print areas list; a negative index value will identify which entry to overwrite working bacward through the print area to the list, with the last entry as -1. Specifying an index value of 0, will overwrite all existing print ranges. When the method is "I"nsert, then a positive index will insert after that indexed entry in the print areas list, while a negative index will insert before the indexed entry. Specifying an index value of 0, will always append the new print range at the end of the list. Print areas are numbered from 1

string $method

Determines the method used when setting multiple print areas Default behaviour, or the "O" method, overwrites existing print area The "I" method, inserts the new print area before any specified index, or at the end of the list

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

$this

addPrintArea()

addPrintArea(string  $value, integer  $index = -1) : $this

Add a new print area (e.g. 'A1:D10' or 'A1:D10,G5:M20') to the list of print areas.

Parameters

string $value
integer $index

Identifier for a specific print area range allowing several ranges to be set A positive index will insert after that indexed entry in the print areas list, while a negative index will insert before the indexed entry. Specifying an index value of 0, will always append the new print range at the end of the list. Print areas are numbered from 1

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

$this

setPrintAreaByColumnAndRow()

setPrintAreaByColumnAndRow(integer  $column1, integer  $row1, integer  $column2, integer  $row2, integer  $index, string  $method = self::SETPRINTRANGE_OVERWRITE) : $this

Set print area.

Parameters

integer $column1

Column 1

integer $row1

Row 1

integer $column2

Column 2

integer $row2

Row 2

integer $index

Identifier for a specific print area range allowing several ranges to be set When the method is "O"verwrite, then a positive integer index will overwrite that indexed entry in the print areas list; a negative index value will identify which entry to overwrite working backward through the print area to the list, with the last entry as -1. Specifying an index value of 0, will overwrite all existing print ranges. When the method is "I"nsert, then a positive index will insert after that indexed entry in the print areas list, while a negative index will insert before the indexed entry. Specifying an index value of 0, will always append the new print range at the end of the list. Print areas are numbered from 1

string $method

Determines the method used when setting multiple print areas Default behaviour, or the "O" method, overwrites existing print area The "I" method, inserts the new print area before any specified index, or at the end of the list

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

$this

addPrintAreaByColumnAndRow()

addPrintAreaByColumnAndRow(integer  $column1, integer  $row1, integer  $column2, integer  $row2, integer  $index = -1) : $this

Add a new print area to the list of print areas.

Parameters

integer $column1

Start Column for the print area

integer $row1

Start Row for the print area

integer $column2

End Column for the print area

integer $row2

End Row for the print area

integer $index

Identifier for a specific print area range allowing several ranges to be set A positive index will insert after that indexed entry in the print areas list, while a negative index will insert before the indexed entry. Specifying an index value of 0, will always append the new print range at the end of the list. Print areas are numbered from 1

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

$this

getFirstPageNumber()

getFirstPageNumber() : integer

Get first page number.

Returns

integer

setFirstPageNumber()

setFirstPageNumber(integer  $value) : $this

Set first page number.

Parameters

integer $value

Returns

$this

resetFirstPageNumber()

resetFirstPageNumber() : $this

Reset first page number.

Returns

$this

__clone()

__clone() 

Implement PHP __clone to create a deep clone, not just a shallow copy.