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

Collaboration diagram for PhpOffice\PhpSpreadsheet\Worksheet\PageSetup:

Public Member Functions
	__construct ()
	Create a new PageSetup. More...

	getPaperSize ()
	Get Paper Size. More...

	setPaperSize ($pValue)
	Set Paper Size. More...

	getOrientation ()
	Get Orientation. More...

	setOrientation ($pValue)
	Set Orientation. More...

	getScale ()
	Get Scale. More...

	setScale ($pValue, $pUpdate=true)
	Set Scale. More...

	getFitToPage ()
	Get Fit To Page. More...

	setFitToPage ($pValue)
	Set Fit To Page. More...

	getFitToHeight ()
	Get Fit To Height. More...

	setFitToHeight ($pValue, $pUpdate=true)
	Set Fit To Height. More...

	getFitToWidth ()
	Get Fit To Width. More...

	setFitToWidth ($pValue, $pUpdate=true)
	Set Fit To Width. More...

	isColumnsToRepeatAtLeftSet ()
	Is Columns to repeat at left set? More...

	getColumnsToRepeatAtLeft ()
	Get Columns to repeat at left. More...

	setColumnsToRepeatAtLeft (array $pValue)
	Set Columns to repeat at left. More...

	setColumnsToRepeatAtLeftByStartAndEnd ($pStart, $pEnd)
	Set Columns to repeat at left by start and end. More...

	isRowsToRepeatAtTopSet ()
	Is Rows to repeat at top set? More...

	getRowsToRepeatAtTop ()
	Get Rows to repeat at top. More...

	setRowsToRepeatAtTop (array $pValue)
	Set Rows to repeat at top. More...

	setRowsToRepeatAtTopByStartAndEnd ($pStart, $pEnd)
	Set Rows to repeat at top by start and end. More...

	getHorizontalCentered ()
	Get center page horizontally. More...

	setHorizontalCentered ($value)
	Set center page horizontally. More...

	getVerticalCentered ()
	Get center page vertically. More...

	setVerticalCentered ($value)
	Set center page vertically. More...

	getPrintArea ($index=0)
	Get print area. More...

	isPrintAreaSet ($index=0)
	Is print area set? More...

	clearPrintArea ($index=0)
	Clear a print area. More...

	setPrintArea ($value, $index=0, $method=self::SETPRINTRANGE_OVERWRITE)
	Set print area. More...

	addPrintArea ($value, $index=-1)
	Add a new print area (e.g. More...

	setPrintAreaByColumnAndRow ($column1, $row1, $column2, $row2, $index=0, $method=self::SETPRINTRANGE_OVERWRITE)
	Set print area. More...

	addPrintAreaByColumnAndRow ($column1, $row1, $column2, $row2, $index=-1)
	Add a new print area to the list of print areas. More...

	getFirstPageNumber ()
	Get first page number. More...

	setFirstPageNumber ($value)
	Set first page number. More...

	resetFirstPageNumber ()
	Reset first page number. More...

	getPageOrder ()

	setPageOrder (?string $pageOrder)

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

Data Fields
const	PAPERSIZE_LETTER = 1

const	PAPERSIZE_LETTER_SMALL = 2

const	PAPERSIZE_TABLOID = 3

const	PAPERSIZE_LEDGER = 4

const	PAPERSIZE_LEGAL = 5

const	PAPERSIZE_STATEMENT = 6

const	PAPERSIZE_EXECUTIVE = 7

const	PAPERSIZE_A3 = 8

const	PAPERSIZE_A4 = 9

const	PAPERSIZE_A4_SMALL = 10

const	PAPERSIZE_A5 = 11

const	PAPERSIZE_B4 = 12

const	PAPERSIZE_B5 = 13

const	PAPERSIZE_FOLIO = 14

const	PAPERSIZE_QUARTO = 15

const	PAPERSIZE_STANDARD_1 = 16

const	PAPERSIZE_STANDARD_2 = 17

const	PAPERSIZE_NOTE = 18

const	PAPERSIZE_NO9_ENVELOPE = 19

const	PAPERSIZE_NO10_ENVELOPE = 20

const	PAPERSIZE_NO11_ENVELOPE = 21

const	PAPERSIZE_NO12_ENVELOPE = 22

const	PAPERSIZE_NO14_ENVELOPE = 23

const	PAPERSIZE_C = 24

const	PAPERSIZE_D = 25

const	PAPERSIZE_E = 26

const	PAPERSIZE_DL_ENVELOPE = 27

const	PAPERSIZE_C5_ENVELOPE = 28

const	PAPERSIZE_C3_ENVELOPE = 29

const	PAPERSIZE_C4_ENVELOPE = 30

const	PAPERSIZE_C6_ENVELOPE = 31

const	PAPERSIZE_C65_ENVELOPE = 32

const	PAPERSIZE_B4_ENVELOPE = 33

const	PAPERSIZE_B5_ENVELOPE = 34

const	PAPERSIZE_B6_ENVELOPE = 35

const	PAPERSIZE_ITALY_ENVELOPE = 36

const	PAPERSIZE_MONARCH_ENVELOPE = 37

const	PAPERSIZE_6_3_4_ENVELOPE = 38

const	PAPERSIZE_US_STANDARD_FANFOLD = 39

const	PAPERSIZE_GERMAN_STANDARD_FANFOLD = 40

const	PAPERSIZE_GERMAN_LEGAL_FANFOLD = 41

const	PAPERSIZE_ISO_B4 = 42

const	PAPERSIZE_JAPANESE_DOUBLE_POSTCARD = 43

const	PAPERSIZE_STANDARD_PAPER_1 = 44

const	PAPERSIZE_STANDARD_PAPER_2 = 45

const	PAPERSIZE_STANDARD_PAPER_3 = 46

const	PAPERSIZE_INVITE_ENVELOPE = 47

const	PAPERSIZE_LETTER_EXTRA_PAPER = 48

const	PAPERSIZE_LEGAL_EXTRA_PAPER = 49

const	PAPERSIZE_TABLOID_EXTRA_PAPER = 50

const	PAPERSIZE_A4_EXTRA_PAPER = 51

const	PAPERSIZE_LETTER_TRANSVERSE_PAPER = 52

const	PAPERSIZE_A4_TRANSVERSE_PAPER = 53

const	PAPERSIZE_LETTER_EXTRA_TRANSVERSE_PAPER = 54

const	PAPERSIZE_SUPERA_SUPERA_A4_PAPER = 55

const	PAPERSIZE_SUPERB_SUPERB_A3_PAPER = 56

const	PAPERSIZE_LETTER_PLUS_PAPER = 57

const	PAPERSIZE_A4_PLUS_PAPER = 58

const	PAPERSIZE_A5_TRANSVERSE_PAPER = 59

const	PAPERSIZE_JIS_B5_TRANSVERSE_PAPER = 60

const	PAPERSIZE_A3_EXTRA_PAPER = 61

const	PAPERSIZE_A5_EXTRA_PAPER = 62

const	PAPERSIZE_ISO_B5_EXTRA_PAPER = 63

const	PAPERSIZE_A2_PAPER = 64

const	PAPERSIZE_A3_TRANSVERSE_PAPER = 65

const	PAPERSIZE_A3_EXTRA_TRANSVERSE_PAPER = 66

const	ORIENTATION_DEFAULT = 'default'

const	ORIENTATION_LANDSCAPE = 'landscape'

const	ORIENTATION_PORTRAIT = 'portrait'

const	SETPRINTRANGE_OVERWRITE = 'O'

const	SETPRINTRANGE_INSERT = 'I'

const	PAGEORDER_OVER_THEN_DOWN = 'overThenDown'

const	PAGEORDER_DOWN_THEN_OVER = 'downThenOver'

Private Attributes
	$paperSize = self::PAPERSIZE_LETTER

	$orientation = self::ORIENTATION_DEFAULT

	$scale = 100

	$fitToPage = false

	$fitToHeight = 1

	$fitToWidth = 1

	$columnsToRepeatAtLeft = ['', '']

	$rowsToRepeatAtTop = [0, 0]

	$horizontalCentered = false

	$verticalCentered = false

	$printArea

	$firstPageNumber

	$pageOrder = self::PAGEORDER_DOWN_THEN_OVER

Detailed Description

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)

Definition at line 80 of file PageSetup.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::__construct ( )

Create a new PageSetup.

Definition at line 257 of file PageSetup.php.

258 {

259 }

Member Function Documentation

◆ __clone()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::__clone ( )

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

Definition at line 846 of file PageSetup.php.

References $key.

     {
         $vars = get_object_vars($this);
         foreach ($vars as $key => $value) {
             if (is_object($value)) {
                 $this->$key = clone $value;
             } else {
                 $this->$key = $value;
             }
         }
     }

◆ addPrintArea()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::addPrintArea	(	$value,
		$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

Returns: $this

Definition at line 733 of file PageSetup.php.

References $index, and PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\setPrintArea().

     {
         return $this->setPrintArea($value, $index, self::SETPRINTRANGE_INSERT);
     }

Here is the call graph for this function:

◆ addPrintAreaByColumnAndRow()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::addPrintAreaByColumnAndRow	(	$column1,
		$row1,
		$column2,
		$row2,
		$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

Returns: $this

Definition at line 786 of file PageSetup.php.

References $index, PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\setPrintArea(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\stringFromColumnIndex().

     {
         return $this->setPrintArea(
             Coordinate::stringFromColumnIndex($column1) . $row1 . ':' . Coordinate::stringFromColumnIndex($column2) . $row2,
             $index,
             self::SETPRINTRANGE_INSERT
         );
     }

Here is the call graph for this function:

◆ clearPrintArea()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::clearPrintArea ( $index = 0 )

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

Returns: $this

Definition at line 636 of file PageSetup.php.

References $index.

     {
         if ($index == 0) {
             $this->printArea = null;
         } else {
             $printAreas = explode(',', $this->printArea);
             if (isset($printAreas[$index - 1])) {
                 unset($printAreas[$index - 1]);
                 $this->printArea = implode(',', $printAreas);
             }
         }
 
         return $this;
     }

◆ getColumnsToRepeatAtLeft()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::getColumnsToRepeatAtLeft ( )

Get Columns to repeat at left.

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

Definition at line 446 of file PageSetup.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\$columnsToRepeatAtLeft.

     {
         return $this->columnsToRepeatAtLeft;
     }

◆ getFirstPageNumber()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::getFirstPageNumber ( )

Get first page number.

Returns: int

Definition at line 800 of file PageSetup.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\$firstPageNumber.

     {
         return $this->firstPageNumber;
     }

◆ getFitToHeight()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::getFitToHeight ( )

Get Fit To Height.

Returns: null|int

Definition at line 374 of file PageSetup.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\$fitToHeight.

     {
         return $this->fitToHeight;
     }

◆ getFitToPage()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::getFitToPage ( )

Get Fit To Page.

Returns: bool

Definition at line 350 of file PageSetup.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\$fitToPage.

     {
         return $this->fitToPage;
     }

◆ getFitToWidth()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::getFitToWidth ( )

Get Fit To Width.

Returns: null|int

Definition at line 402 of file PageSetup.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\$fitToWidth.

     {
         return $this->fitToWidth;
     }

◆ getHorizontalCentered()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::getHorizontalCentered ( )

Get center page horizontally.

Returns: bool

Definition at line 540 of file PageSetup.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\$horizontalCentered.

     {
         return $this->horizontalCentered;
     }

◆ getOrientation()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::getOrientation ( )

Get Orientation.

Returns: string

Definition at line 290 of file PageSetup.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\$orientation.

     {
         return $this->orientation;
     }

◆ getPageOrder()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::getPageOrder ( )

Definition at line 829 of file PageSetup.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\$pageOrder.

                                   : string
     {
         return $this->pageOrder;
     }

◆ getPaperSize()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::getPaperSize ( )

Get Paper Size.

Returns: int

Definition at line 266 of file PageSetup.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\$paperSize.

     {
         return $this->paperSize;
     }

◆ getPrintArea()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::getPrintArea ( $index = 0 )

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

Returns: string

Definition at line 593 of file PageSetup.php.

References $index, and PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\$printArea.

     {
         if ($index == 0) {
             return $this->printArea;
         }
         $printAreas = explode(',', $this->printArea);
         if (isset($printAreas[$index - 1])) {
             return $printAreas[$index - 1];
         }
 
         throw new PhpSpreadsheetException('Requested Print Area does not exist');
     }

◆ getRowsToRepeatAtTop()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::getRowsToRepeatAtTop ( )

Get Rows to repeat at top.

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

Definition at line 501 of file PageSetup.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\$rowsToRepeatAtTop.

     {
         return $this->rowsToRepeatAtTop;
     }

◆ getScale()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::getScale ( )

Get Scale.

Returns: null|int

Definition at line 314 of file PageSetup.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\$scale.

     {
         return $this->scale;
     }

◆ getVerticalCentered()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::getVerticalCentered ( )

Get center page vertically.

Returns: bool

Definition at line 564 of file PageSetup.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\$verticalCentered.

     {
         return $this->verticalCentered;
     }

◆ isColumnsToRepeatAtLeftSet()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::isColumnsToRepeatAtLeftSet ( )

Is Columns to repeat at left set?

Returns: bool

Definition at line 430 of file PageSetup.php.

     {
         if (is_array($this->columnsToRepeatAtLeft)) {
             if ($this->columnsToRepeatAtLeft[0] != '' && $this->columnsToRepeatAtLeft[1] != '') {
                 return true;
             }
         }
 
         return false;
     }

◆ isPrintAreaSet()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::isPrintAreaSet ( $index = 0 )

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

Returns: bool

Definition at line 616 of file PageSetup.php.

References $index.

     {
         if ($index == 0) {
             return $this->printArea !== null;
         }
         $printAreas = explode(',', $this->printArea);
 
         return isset($printAreas[$index - 1]);
     }

◆ isRowsToRepeatAtTopSet()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::isRowsToRepeatAtTopSet ( )

Is Rows to repeat at top set?

Returns: bool

Definition at line 485 of file PageSetup.php.

     {
         if (is_array($this->rowsToRepeatAtTop)) {
             if ($this->rowsToRepeatAtTop[0] != 0 && $this->rowsToRepeatAtTop[1] != 0) {
                 return true;
             }
         }
 
         return false;
     }

◆ resetFirstPageNumber()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::resetFirstPageNumber ( )

Reset first page number.

Returns: $this

Definition at line 824 of file PageSetup.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\setFirstPageNumber().

     {
         return $this->setFirstPageNumber(null);
     }

Here is the call graph for this function:

◆ setColumnsToRepeatAtLeft()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::setColumnsToRepeatAtLeft ( array $pValue )

Set Columns to repeat at left.

Parameters

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

Returns: $this

Definition at line 458 of file PageSetup.php.

     {
         $this->columnsToRepeatAtLeft = $pValue;
 
         return $this;
     }

◆ setColumnsToRepeatAtLeftByStartAndEnd()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::setColumnsToRepeatAtLeftByStartAndEnd	(	$pStart,
		$pEnd
	)

Set Columns to repeat at left by start and end.

Parameters

string	$pStart	eg: 'A'
string	$pEnd	eg: 'B'

Returns: $this

Definition at line 473 of file PageSetup.php.

     {
         $this->columnsToRepeatAtLeft = [$pStart, $pEnd];
 
         return $this;
     }

◆ setFirstPageNumber()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::setFirstPageNumber ( $value )

Set first page number.

Parameters

int $value

Returns: $this

Definition at line 812 of file PageSetup.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\resetFirstPageNumber().

     {
         $this->firstPageNumber = $value;
 
         return $this;
     }

Here is the caller graph for this function:

◆ setFitToHeight()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::setFitToHeight	(	$pValue,
		$pUpdate = `true`
	)

Set Fit To Height.

Parameters

null \| int	$pValue
bool	$pUpdate	Update fitToPage so it applies rather than scaling

Returns: $this

Definition at line 387 of file PageSetup.php.

     {
         $this->fitToHeight = $pValue;
         if ($pUpdate) {
             $this->fitToPage = true;
         }
 
         return $this;
     }

◆ setFitToPage()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::setFitToPage ( $pValue )

Set Fit To Page.

Parameters

bool $pValue

Returns: $this

Definition at line 362 of file PageSetup.php.

     {
         $this->fitToPage = $pValue;
 
         return $this;
     }

◆ setFitToWidth()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::setFitToWidth	(	$pValue,
		$pUpdate = `true`
	)

Set Fit To Width.

Parameters

null \| int	$pValue
bool	$pUpdate	Update fitToPage so it applies rather than scaling

Returns: $this

Definition at line 415 of file PageSetup.php.

     {
         $this->fitToWidth = $pValue;
         if ($pUpdate) {
             $this->fitToPage = true;
         }
 
         return $this;
     }

◆ setHorizontalCentered()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::setHorizontalCentered ( $value )

Set center page horizontally.

Parameters

bool $value

Returns: $this

Definition at line 552 of file PageSetup.php.

     {
         $this->horizontalCentered = $value;
 
         return $this;
     }

◆ setOrientation()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::setOrientation ( $pValue )

Set Orientation.

Parameters

string $pValue see self::ORIENTATION_*

Returns: $this

Definition at line 302 of file PageSetup.php.

     {
         $this->orientation = $pValue;
 
         return $this;
     }

◆ setPageOrder()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::setPageOrder ( ?string $pageOrder )

Definition at line 834 of file PageSetup.php.

                                                     : self
     {
         if ($pageOrder === null || $pageOrder === self::PAGEORDER_DOWN_THEN_OVER || $pageOrder === self::PAGEORDER_OVER_THEN_DOWN) {
             $this->pageOrder = $pageOrder ?? self::PAGEORDER_DOWN_THEN_OVER;
         }
 
         return $this;
     }

◆ setPaperSize()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::setPaperSize ( $pValue )

Set Paper Size.

Parameters

int $pValue see self::PAPERSIZE_*

Returns: $this

Definition at line 278 of file PageSetup.php.

     {
         $this->paperSize = $pValue;
 
         return $this;
     }

◆ setPrintArea()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::setPrintArea	(	$value,
		$index = `0`,
		$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

Returns: $this

Definition at line 671 of file PageSetup.php.

References $index.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\addPrintArea(), PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\addPrintAreaByColumnAndRow(), and PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\setPrintAreaByColumnAndRow().

     {
         if (strpos($value, '!') !== false) {
             throw new PhpSpreadsheetException('Cell coordinate must not specify a worksheet.');
         } elseif (strpos($value, ':') === false) {
             throw new PhpSpreadsheetException('Cell coordinate must be a range of cells.');
         } elseif (strpos($value, '$') !== false) {
             throw new PhpSpreadsheetException('Cell coordinate must not be absolute.');
         }
         $value = strtoupper($value);
         if (!$this->printArea) {
             $index = 0;
         }
 
         if ($method == self::SETPRINTRANGE_OVERWRITE) {
             if ($index == 0) {
                 $this->printArea = $value;
             } else {
                 $printAreas = explode(',', $this->printArea);
                 if ($index < 0) {
                     $index = count($printAreas) - abs($index) + 1;
                 }
                 if (($index <= 0) || ($index > count($printAreas))) {
                     throw new PhpSpreadsheetException('Invalid index for setting print range.');
                 }
                 $printAreas[$index - 1] = $value;
                 $this->printArea = implode(',', $printAreas);
             }
         } elseif ($method == self::SETPRINTRANGE_INSERT) {
             if ($index == 0) {
                 $this->printArea = $this->printArea ? ($this->printArea . ',' . $value) : $value;
             } else {
                 $printAreas = explode(',', $this->printArea);
                 if ($index < 0) {
                     $index = abs($index) - 1;
                 }
                 if ($index > count($printAreas)) {
                     throw new PhpSpreadsheetException('Invalid index for setting print range.');
                 }
                 $printAreas = array_merge(array_slice($printAreas, 0, $index), [$value], array_slice($printAreas, $index));
                 $this->printArea = implode(',', $printAreas);
             }
         } else {
             throw new PhpSpreadsheetException('Invalid method for setting print range.');
         }
 
         return $this;
     }

Here is the caller graph for this function:

◆ setPrintAreaByColumnAndRow()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::setPrintAreaByColumnAndRow	(	$column1,
		$row1,
		$column2,
		$row2,
		$index = `0`,
		$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 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

Returns: $this

Definition at line 761 of file PageSetup.php.

References $index, PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\setPrintArea(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\stringFromColumnIndex().

     {
         return $this->setPrintArea(
             Coordinate::stringFromColumnIndex($column1) . $row1 . ':' . Coordinate::stringFromColumnIndex($column2) . $row2,
             $index,
             $method
         );
     }

Here is the call graph for this function:

◆ setRowsToRepeatAtTop()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::setRowsToRepeatAtTop ( array $pValue )

Set Rows to repeat at top.

Parameters

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

Returns: $this

Definition at line 513 of file PageSetup.php.

     {
         $this->rowsToRepeatAtTop = $pValue;
 
         return $this;
     }

◆ setRowsToRepeatAtTopByStartAndEnd()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::setRowsToRepeatAtTopByStartAndEnd	(	$pStart,
		$pEnd
	)

Set Rows to repeat at top by start and end.

Parameters

int	$pStart	eg: 1
int	$pEnd	eg: 1

Returns: $this

Definition at line 528 of file PageSetup.php.

     {
         $this->rowsToRepeatAtTop = [$pStart, $pEnd];
 
         return $this;
     }

◆ setScale()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::setScale	(	$pValue,
		$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

null \| int	$pValue
bool	$pUpdate	Update fitToPage so scaling applies rather than fitToHeight / fitToWidth

Returns: $this

Definition at line 329 of file PageSetup.php.

     {
         // Microsoft Office Excel 2007 only allows setting a scale between 10 and 400 via the user interface,
         // but it is apparently still able to handle any scale >= 0, where 0 results in 100
         if (($pValue >= 0) || $pValue === null) {
             $this->scale = $pValue;
             if ($pUpdate) {
                 $this->fitToPage = false;
             }
         } else {
             throw new PhpSpreadsheetException('Scale must not be negative');
         }
 
         return $this;
     }

◆ setVerticalCentered()

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::setVerticalCentered ( $value )

Set center page vertically.

Parameters

bool $value

Returns: $this

Definition at line 576 of file PageSetup.php.

     {
         $this->verticalCentered = $value;
 
         return $this;
     }

Field Documentation

◆ $columnsToRepeatAtLeft

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::$columnsToRepeatAtLeft = ['', '']

private

Definition at line 215 of file PageSetup.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\getColumnsToRepeatAtLeft().

◆ $firstPageNumber

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::$firstPageNumber

private

Definition at line 250 of file PageSetup.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\getFirstPageNumber().

◆ $fitToHeight

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::$fitToHeight = 1

private

Definition at line 200 of file PageSetup.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\getFitToHeight().

◆ $fitToPage

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::$fitToPage = false

private

Definition at line 192 of file PageSetup.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\getFitToPage().

◆ $fitToWidth

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::$fitToWidth = 1

private

Definition at line 208 of file PageSetup.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\getFitToWidth().

◆ $horizontalCentered

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::$horizontalCentered = false

private

Definition at line 229 of file PageSetup.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\getHorizontalCentered().

◆ $orientation

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::$orientation = self::ORIENTATION_DEFAULT

private

Definition at line 174 of file PageSetup.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\getOrientation().

◆ $pageOrder

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::$pageOrder = self::PAGEORDER_DOWN_THEN_OVER

private

Definition at line 252 of file PageSetup.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\getPageOrder().

◆ $paperSize

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::$paperSize = self::PAPERSIZE_LETTER

private

Definition at line 167 of file PageSetup.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\getPaperSize().

◆ $printArea

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::$printArea

private

Definition at line 243 of file PageSetup.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\getPrintArea().

◆ $rowsToRepeatAtTop

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::$rowsToRepeatAtTop = [0, 0]

private

Definition at line 222 of file PageSetup.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\getRowsToRepeatAtTop().

◆ $scale

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::$scale = 100

private

Definition at line 184 of file PageSetup.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\getScale().

◆ $verticalCentered

PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::$verticalCentered = false

private

Definition at line 236 of file PageSetup.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\getVerticalCentered().

◆ ORIENTATION_DEFAULT

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::ORIENTATION_DEFAULT = 'default'

Definition at line 151 of file PageSetup.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Pdf\Dompdf\save(), and PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf\save().

◆ ORIENTATION_LANDSCAPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::ORIENTATION_LANDSCAPE = 'landscape'

Definition at line 152 of file PageSetup.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generatePageDeclarations(), PhpOffice\PhpSpreadsheet\Writer\Pdf\Dompdf\save(), PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf\save(), PhpOffice\PhpSpreadsheet\Writer\Pdf\Tcpdf\save(), and PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeSetup().

◆ ORIENTATION_PORTRAIT

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::ORIENTATION_PORTRAIT = 'portrait'

Definition at line 153 of file PageSetup.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generatePageDeclarations(), PhpOffice\PhpSpreadsheet\Writer\Pdf\Dompdf\save(), and PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf\save().

◆ PAGEORDER_DOWN_THEN_OVER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAGEORDER_DOWN_THEN_OVER = 'downThenOver'

Definition at line 160 of file PageSetup.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeSetup().

◆ PAGEORDER_OVER_THEN_DOWN

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAGEORDER_OVER_THEN_DOWN = 'overThenDown'

Definition at line 159 of file PageSetup.php.

◆ PAPERSIZE_6_3_4_ENVELOPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_6_3_4_ENVELOPE = 38

Definition at line 120 of file PageSetup.php.

◆ PAPERSIZE_A2_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_A2_PAPER = 64

Definition at line 146 of file PageSetup.php.

◆ PAPERSIZE_A3

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_A3 = 8

Definition at line 90 of file PageSetup.php.

◆ PAPERSIZE_A3_EXTRA_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_A3_EXTRA_PAPER = 61

Definition at line 143 of file PageSetup.php.

◆ PAPERSIZE_A3_EXTRA_TRANSVERSE_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_A3_EXTRA_TRANSVERSE_PAPER = 66

Definition at line 148 of file PageSetup.php.

◆ PAPERSIZE_A3_TRANSVERSE_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_A3_TRANSVERSE_PAPER = 65

Definition at line 147 of file PageSetup.php.

◆ PAPERSIZE_A4

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_A4 = 9

Definition at line 91 of file PageSetup.php.

◆ PAPERSIZE_A4_EXTRA_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_A4_EXTRA_PAPER = 51

Definition at line 133 of file PageSetup.php.

◆ PAPERSIZE_A4_PLUS_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_A4_PLUS_PAPER = 58

Definition at line 140 of file PageSetup.php.

◆ PAPERSIZE_A4_SMALL

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_A4_SMALL = 10

Definition at line 92 of file PageSetup.php.

◆ PAPERSIZE_A4_TRANSVERSE_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_A4_TRANSVERSE_PAPER = 53

Definition at line 135 of file PageSetup.php.

◆ PAPERSIZE_A5

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_A5 = 11

Definition at line 93 of file PageSetup.php.

◆ PAPERSIZE_A5_EXTRA_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_A5_EXTRA_PAPER = 62

Definition at line 144 of file PageSetup.php.

◆ PAPERSIZE_A5_TRANSVERSE_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_A5_TRANSVERSE_PAPER = 59

Definition at line 141 of file PageSetup.php.

◆ PAPERSIZE_B4

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_B4 = 12

Definition at line 94 of file PageSetup.php.

◆ PAPERSIZE_B4_ENVELOPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_B4_ENVELOPE = 33

Definition at line 115 of file PageSetup.php.

◆ PAPERSIZE_B5

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_B5 = 13

Definition at line 95 of file PageSetup.php.

◆ PAPERSIZE_B5_ENVELOPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_B5_ENVELOPE = 34

Definition at line 116 of file PageSetup.php.

◆ PAPERSIZE_B6_ENVELOPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_B6_ENVELOPE = 35

Definition at line 117 of file PageSetup.php.

◆ PAPERSIZE_C

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_C = 24

Definition at line 106 of file PageSetup.php.

◆ PAPERSIZE_C3_ENVELOPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_C3_ENVELOPE = 29

Definition at line 111 of file PageSetup.php.

◆ PAPERSIZE_C4_ENVELOPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_C4_ENVELOPE = 30

Definition at line 112 of file PageSetup.php.

◆ PAPERSIZE_C5_ENVELOPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_C5_ENVELOPE = 28

Definition at line 110 of file PageSetup.php.

◆ PAPERSIZE_C65_ENVELOPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_C65_ENVELOPE = 32

Definition at line 114 of file PageSetup.php.

◆ PAPERSIZE_C6_ENVELOPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_C6_ENVELOPE = 31

Definition at line 113 of file PageSetup.php.

◆ PAPERSIZE_D

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_D = 25

Definition at line 107 of file PageSetup.php.

◆ PAPERSIZE_DL_ENVELOPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_DL_ENVELOPE = 27

Definition at line 109 of file PageSetup.php.

◆ PAPERSIZE_E

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_E = 26

Definition at line 108 of file PageSetup.php.

◆ PAPERSIZE_EXECUTIVE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_EXECUTIVE = 7

Definition at line 89 of file PageSetup.php.

◆ PAPERSIZE_FOLIO

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_FOLIO = 14

Definition at line 96 of file PageSetup.php.

◆ PAPERSIZE_GERMAN_LEGAL_FANFOLD

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_GERMAN_LEGAL_FANFOLD = 41

Definition at line 123 of file PageSetup.php.

◆ PAPERSIZE_GERMAN_STANDARD_FANFOLD

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_GERMAN_STANDARD_FANFOLD = 40

Definition at line 122 of file PageSetup.php.

◆ PAPERSIZE_INVITE_ENVELOPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_INVITE_ENVELOPE = 47

Definition at line 129 of file PageSetup.php.

◆ PAPERSIZE_ISO_B4

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_ISO_B4 = 42

Definition at line 124 of file PageSetup.php.

◆ PAPERSIZE_ISO_B5_EXTRA_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_ISO_B5_EXTRA_PAPER = 63

Definition at line 145 of file PageSetup.php.

◆ PAPERSIZE_ITALY_ENVELOPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_ITALY_ENVELOPE = 36

Definition at line 118 of file PageSetup.php.

◆ PAPERSIZE_JAPANESE_DOUBLE_POSTCARD

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_JAPANESE_DOUBLE_POSTCARD = 43

Definition at line 125 of file PageSetup.php.

◆ PAPERSIZE_JIS_B5_TRANSVERSE_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_JIS_B5_TRANSVERSE_PAPER = 60

Definition at line 142 of file PageSetup.php.

◆ PAPERSIZE_LEDGER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_LEDGER = 4

Definition at line 86 of file PageSetup.php.

◆ PAPERSIZE_LEGAL

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_LEGAL = 5

Definition at line 87 of file PageSetup.php.

◆ PAPERSIZE_LEGAL_EXTRA_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_LEGAL_EXTRA_PAPER = 49

Definition at line 131 of file PageSetup.php.

◆ PAPERSIZE_LETTER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_LETTER = 1

Definition at line 83 of file PageSetup.php.

◆ PAPERSIZE_LETTER_EXTRA_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_LETTER_EXTRA_PAPER = 48

Definition at line 130 of file PageSetup.php.

◆ PAPERSIZE_LETTER_EXTRA_TRANSVERSE_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_LETTER_EXTRA_TRANSVERSE_PAPER = 54

Definition at line 136 of file PageSetup.php.

◆ PAPERSIZE_LETTER_PLUS_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_LETTER_PLUS_PAPER = 57

Definition at line 139 of file PageSetup.php.

◆ PAPERSIZE_LETTER_SMALL

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_LETTER_SMALL = 2

Definition at line 84 of file PageSetup.php.

◆ PAPERSIZE_LETTER_TRANSVERSE_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_LETTER_TRANSVERSE_PAPER = 52

Definition at line 134 of file PageSetup.php.

◆ PAPERSIZE_MONARCH_ENVELOPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_MONARCH_ENVELOPE = 37

Definition at line 119 of file PageSetup.php.

◆ PAPERSIZE_NO10_ENVELOPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_NO10_ENVELOPE = 20

Definition at line 102 of file PageSetup.php.

◆ PAPERSIZE_NO11_ENVELOPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_NO11_ENVELOPE = 21

Definition at line 103 of file PageSetup.php.

◆ PAPERSIZE_NO12_ENVELOPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_NO12_ENVELOPE = 22

Definition at line 104 of file PageSetup.php.

◆ PAPERSIZE_NO14_ENVELOPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_NO14_ENVELOPE = 23

Definition at line 105 of file PageSetup.php.

◆ PAPERSIZE_NO9_ENVELOPE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_NO9_ENVELOPE = 19

Definition at line 101 of file PageSetup.php.

◆ PAPERSIZE_NOTE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_NOTE = 18

Definition at line 100 of file PageSetup.php.

◆ PAPERSIZE_QUARTO

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_QUARTO = 15

Definition at line 97 of file PageSetup.php.

◆ PAPERSIZE_STANDARD_1

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_STANDARD_1 = 16

Definition at line 98 of file PageSetup.php.

◆ PAPERSIZE_STANDARD_2

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_STANDARD_2 = 17

Definition at line 99 of file PageSetup.php.

◆ PAPERSIZE_STANDARD_PAPER_1

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_STANDARD_PAPER_1 = 44

Definition at line 126 of file PageSetup.php.

◆ PAPERSIZE_STANDARD_PAPER_2

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_STANDARD_PAPER_2 = 45

Definition at line 127 of file PageSetup.php.

◆ PAPERSIZE_STANDARD_PAPER_3

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_STANDARD_PAPER_3 = 46

Definition at line 128 of file PageSetup.php.

◆ PAPERSIZE_STATEMENT

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_STATEMENT = 6

Definition at line 88 of file PageSetup.php.

◆ PAPERSIZE_SUPERA_SUPERA_A4_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_SUPERA_SUPERA_A4_PAPER = 55

Definition at line 137 of file PageSetup.php.

◆ PAPERSIZE_SUPERB_SUPERB_A3_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_SUPERB_SUPERB_A3_PAPER = 56

Definition at line 138 of file PageSetup.php.

◆ PAPERSIZE_TABLOID

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_TABLOID = 3

Definition at line 85 of file PageSetup.php.

◆ PAPERSIZE_TABLOID_EXTRA_PAPER

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_TABLOID_EXTRA_PAPER = 50

Definition at line 132 of file PageSetup.php.

◆ PAPERSIZE_US_STANDARD_FANFOLD

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_US_STANDARD_FANFOLD = 39

Definition at line 121 of file PageSetup.php.

◆ SETPRINTRANGE_INSERT

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::SETPRINTRANGE_INSERT = 'I'

Definition at line 157 of file PageSetup.php.

◆ SETPRINTRANGE_OVERWRITE

const PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::SETPRINTRANGE_OVERWRITE = 'O'

Definition at line 156 of file PageSetup.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Worksheet/PageSetup.php

Public Member Functions

Data Fields

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ addPrintArea()

◆ addPrintAreaByColumnAndRow()

◆ clearPrintArea()

◆ getColumnsToRepeatAtLeft()

◆ getFirstPageNumber()

◆ getFitToHeight()

◆ getFitToPage()

◆ getFitToWidth()

◆ getHorizontalCentered()

◆ getOrientation()

◆ getPageOrder()

◆ getPaperSize()

◆ getPrintArea()

◆ getRowsToRepeatAtTop()

◆ getScale()

◆ getVerticalCentered()

◆ isColumnsToRepeatAtLeftSet()

◆ isPrintAreaSet()

◆ isRowsToRepeatAtTopSet()

◆ resetFirstPageNumber()

◆ setColumnsToRepeatAtLeft()

◆ setColumnsToRepeatAtLeftByStartAndEnd()

◆ setFirstPageNumber()

◆ setFitToHeight()

◆ setFitToPage()

◆ setFitToWidth()

◆ setHorizontalCentered()

◆ setOrientation()

◆ setPageOrder()

◆ setPaperSize()

◆ setPrintArea()

◆ setPrintAreaByColumnAndRow()

◆ setRowsToRepeatAtTop()

◆ setRowsToRepeatAtTopByStartAndEnd()

◆ setScale()

◆ setVerticalCentered()

Field Documentation

◆ $columnsToRepeatAtLeft

◆ $firstPageNumber

◆ $fitToHeight

◆ $fitToPage

◆ $fitToWidth

◆ $horizontalCentered

◆ $orientation

◆ $pageOrder

◆ $paperSize

◆ $printArea

◆ $rowsToRepeatAtTop

◆ $scale

◆ $verticalCentered

◆ ORIENTATION_DEFAULT

◆ ORIENTATION_LANDSCAPE

◆ ORIENTATION_PORTRAIT

◆ PAGEORDER_DOWN_THEN_OVER

◆ PAGEORDER_OVER_THEN_DOWN

◆ PAPERSIZE_6_3_4_ENVELOPE

◆ PAPERSIZE_A2_PAPER

◆ PAPERSIZE_A3

◆ PAPERSIZE_A3_EXTRA_PAPER

◆ PAPERSIZE_A3_EXTRA_TRANSVERSE_PAPER

◆ PAPERSIZE_A3_TRANSVERSE_PAPER

◆ PAPERSIZE_A4

◆ PAPERSIZE_A4_EXTRA_PAPER

◆ PAPERSIZE_A4_PLUS_PAPER

◆ PAPERSIZE_A4_SMALL

◆ PAPERSIZE_A4_TRANSVERSE_PAPER

◆ PAPERSIZE_A5

◆ PAPERSIZE_A5_EXTRA_PAPER

◆ PAPERSIZE_A5_TRANSVERSE_PAPER

◆ PAPERSIZE_B4

◆ PAPERSIZE_B4_ENVELOPE

◆ PAPERSIZE_B5