class PHPExcel_Worksheet_PageSetup

PHPExcelWorksheetPageSetup

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)

Constants

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

Methods

__construct()

Create a new PHPExcelWorksheetPageSetup

int
getPaperSize()

Get Paper Size

setPaperSize(int $pValue = PHPExcel_Worksheet_PageSetup::PAPERSIZE_LETTER)

Set Paper Size

string
getOrientation()

Get Orientation

setOrientation(string $pValue = PHPExcel_Worksheet_PageSetup::ORIENTATION_DEFAULT)

Set Orientation

int?
getScale()

Get Scale

setScale(int? $pValue = 100, boolean $pUpdate = true)

Set Scale

boolean
getFitToPage()

Get Fit To Page

setFitToPage(boolean $pValue = true)

Set Fit To Page

int?
getFitToHeight()

Get Fit To Height

setFitToHeight(int? $pValue = 1, boolean $pUpdate = true)

Set Fit To Height

int?
getFitToWidth()

Get Fit To Width

setFitToWidth(int? $pValue = 1, boolean $pUpdate = true)

Set Fit To Width

boolean
isColumnsToRepeatAtLeftSet()

Is Columns to repeat at left set?

array
getColumnsToRepeatAtLeft()

Get Columns to repeat at left

setColumnsToRepeatAtLeft(array $pValue = null)

Set Columns to repeat at left

setColumnsToRepeatAtLeftByStartAndEnd(string $pStart = 'A', string $pEnd = 'A')

Set Columns to repeat at left by start and end

boolean
isRowsToRepeatAtTopSet()

Is Rows to repeat at top set?

array
getRowsToRepeatAtTop()

Get Rows to repeat at top

setRowsToRepeatAtTop(array $pValue = null)

Set Rows to repeat at top

setRowsToRepeatAtTopByStartAndEnd(int $pStart = 1, int $pEnd = 1)

Set Rows to repeat at top by start and end

bool
getHorizontalCentered()

Get center page horizontally

setHorizontalCentered(bool $value = false)

Set center page horizontally

bool
getVerticalCentered()

Get center page vertically

setVerticalCentered(bool $value = false)

Set center page vertically

string
getPrintArea(int $index)

Get print area

boolean
isPrintAreaSet(int $index)

Is print area set?

clearPrintArea(int $index)

Clear a print area

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

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

addPrintArea(string $value, int $index = -1)

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

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

Set print area

addPrintAreaByColumnAndRow(int $column1, int $row1, int $column2, int $row2, int $index = -1)

Add a new print area to the list of print areas

int
getFirstPageNumber()

Get first page number

setFirstPageNumber(int $value = null)

Set first page number

__clone()

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

Details

at line 289
__construct()

Create a new PHPExcelWorksheetPageSetup

at line 298
int getPaperSize()

Get Paper Size

Return Value

int

at line 309
PHPExcel_Worksheet_PageSetup setPaperSize(int $pValue = PHPExcel_Worksheet_PageSetup::PAPERSIZE_LETTER)

Set Paper Size

Parameters

int $pValue

Return Value

PHPExcel_Worksheet_PageSetup

at line 320
string getOrientation()

Get Orientation

Return Value

string

at line 331
PHPExcel_Worksheet_PageSetup setOrientation(string $pValue = PHPExcel_Worksheet_PageSetup::ORIENTATION_DEFAULT)

Set Orientation

Parameters

string $pValue

Return Value

PHPExcel_Worksheet_PageSetup

at line 342
int? getScale()

Get Scale

Return Value

int?

at line 358
PHPExcel_Worksheet_PageSetup setScale(int? $pValue = 100, boolean $pUpdate = true)

Set Scale

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

Parameters

int? $pValue
boolean $pUpdate Update fitToPage so scaling applies rather than fitToHeight / fitToWidth

Return Value

PHPExcel_Worksheet_PageSetup

Exceptions

PHPExcel_Exception

at line 378
boolean getFitToPage()

Get Fit To Page

Return Value

boolean

at line 389
PHPExcel_Worksheet_PageSetup setFitToPage(boolean $pValue = true)

Set Fit To Page

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_PageSetup

at line 400
int? getFitToHeight()

Get Fit To Height

Return Value

int?

at line 412
PHPExcel_Worksheet_PageSetup setFitToHeight(int? $pValue = 1, boolean $pUpdate = true)

Set Fit To Height

Parameters

int? $pValue
boolean $pUpdate Update fitToPage so it applies rather than scaling

Return Value

PHPExcel_Worksheet_PageSetup

at line 426
int? getFitToWidth()

Get Fit To Width

Return Value

int?

at line 438
PHPExcel_Worksheet_PageSetup setFitToWidth(int? $pValue = 1, boolean $pUpdate = true)

Set Fit To Width

Parameters

int? $pValue
boolean $pUpdate Update fitToPage so it applies rather than scaling

Return Value

PHPExcel_Worksheet_PageSetup

at line 452
boolean isColumnsToRepeatAtLeftSet()

Is Columns to repeat at left set?

Return Value

boolean

at line 468
array getColumnsToRepeatAtLeft()

Get Columns to repeat at left

Return Value

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

at line 479
PHPExcel_Worksheet_PageSetup setColumnsToRepeatAtLeft(array $pValue = null)

Set Columns to repeat at left

Parameters

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

Return Value

PHPExcel_Worksheet_PageSetup

at line 494
PHPExcel_Worksheet_PageSetup setColumnsToRepeatAtLeftByStartAndEnd(string $pStart = 'A', string $pEnd = 'A')

Set Columns to repeat at left by start and end

Parameters

string $pStart
string $pEnd

Return Value

PHPExcel_Worksheet_PageSetup

at line 505
boolean isRowsToRepeatAtTopSet()

Is Rows to repeat at top set?

Return Value

boolean

at line 521
array getRowsToRepeatAtTop()

Get Rows to repeat at top

Return Value

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

at line 532
PHPExcel_Worksheet_PageSetup setRowsToRepeatAtTop(array $pValue = null)

Set Rows to repeat at top

Parameters

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

Return Value

PHPExcel_Worksheet_PageSetup

at line 547
PHPExcel_Worksheet_PageSetup setRowsToRepeatAtTopByStartAndEnd(int $pStart = 1, int $pEnd = 1)

Set Rows to repeat at top by start and end

Parameters

int $pStart
int $pEnd

Return Value

PHPExcel_Worksheet_PageSetup

at line 558
bool getHorizontalCentered()

Get center page horizontally

Return Value

bool

at line 569
PHPExcel_Worksheet_PageSetup setHorizontalCentered(bool $value = false)

Set center page horizontally

Parameters

bool $value

Return Value

PHPExcel_Worksheet_PageSetup

at line 580
bool getVerticalCentered()

Get center page vertically

Return Value

bool

at line 591
PHPExcel_Worksheet_PageSetup setVerticalCentered(bool $value = false)

Set center page vertically

Parameters

bool $value

Return Value

PHPExcel_Worksheet_PageSetup

at line 607
string getPrintArea(int $index)

Get print area

Parameters

int $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

Return Value

string

Exceptions

PHPExcel_Exception

at line 628
boolean isPrintAreaSet(int $index)

Is print area set?

Parameters

int $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

Return Value

boolean

at line 646
PHPExcel_Worksheet_PageSetup clearPrintArea(int $index)

Clear a print area

Parameters

int $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

Return Value

PHPExcel_Worksheet_PageSetup

at line 681
PHPExcel_Worksheet_PageSetup setPrintArea(string $value, int $index, string $method = self::SETPRINTRANGE_OVERWRITE)

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

Parameters

string $value
int $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

Return Value

PHPExcel_Worksheet_PageSetup

Exceptions

PHPExcel_Exception

at line 740
PHPExcel_Worksheet_PageSetup addPrintArea(string $value, int $index = -1)

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

Parameters

string $value
int $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

Return Value

PHPExcel_Worksheet_PageSetup

Exceptions

PHPExcel_Exception

at line 768
PHPExcel_Worksheet_PageSetup setPrintAreaByColumnAndRow(int $column1, int $row1, int $column2, int $row2, int $index, string $method = self::SETPRINTRANGE_OVERWRITE)

Set print area

Parameters

int $column1 Column 1
int $row1 Row 1
int $column2 Column 2
int $row2 Row 2
int $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

Return Value

PHPExcel_Worksheet_PageSetup

Exceptions

PHPExcel_Exception

at line 793
PHPExcel_Worksheet_PageSetup addPrintAreaByColumnAndRow(int $column1, int $row1, int $column2, int $row2, int $index = -1)

Add a new print area to the list of print areas

Parameters

int $column1 Start Column for the print area
int $row1 Start Row for the print area
int $column2 End Column for the print area
int $row2 End Row for the print area
int $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

Return Value

PHPExcel_Worksheet_PageSetup

Exceptions

PHPExcel_Exception

at line 807
int getFirstPageNumber()

Get first page number

Return Value

int

at line 818
PHPExcel_Worksheet_HeaderFooter setFirstPageNumber(int $value = null)

Set first page number

Parameters

int $value

Return Value

PHPExcel_Worksheet_HeaderFooter

at line 829
PHPExcel_Worksheet_HeaderFooter resetFirstPageNumber()

Reset first page number

at line 837
__clone()

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