Documentation

PageSetup
in package

<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)

Table of Contents

Constants

ORIENTATION_DEFAULT  = 'default'
ORIENTATION_LANDSCAPE  = 'landscape'
ORIENTATION_PORTRAIT  = 'portrait'
PAGEORDER_DOWN_THEN_OVER  = 'downThenOver'
PAGEORDER_OVER_THEN_DOWN  = 'overThenDown'
PAPERSIZE_6_3_4_ENVELOPE  = 38
PAPERSIZE_A2_PAPER  = 64
PAPERSIZE_A3  = 8
PAPERSIZE_A3_EXTRA_PAPER  = 61
PAPERSIZE_A3_EXTRA_TRANSVERSE_PAPER  = 66
PAPERSIZE_A3_TRANSVERSE_PAPER  = 65
PAPERSIZE_A4  = 9
PAPERSIZE_A4_EXTRA_PAPER  = 51
PAPERSIZE_A4_PLUS_PAPER  = 58
PAPERSIZE_A4_SMALL  = 10
PAPERSIZE_A4_TRANSVERSE_PAPER  = 53
PAPERSIZE_A5  = 11
PAPERSIZE_A5_EXTRA_PAPER  = 62
PAPERSIZE_A5_TRANSVERSE_PAPER  = 59
PAPERSIZE_B4  = 12
PAPERSIZE_B4_ENVELOPE  = 33
PAPERSIZE_B5  = 13
PAPERSIZE_B5_ENVELOPE  = 34
PAPERSIZE_B6_ENVELOPE  = 35
PAPERSIZE_C  = 24
PAPERSIZE_C3_ENVELOPE  = 29
PAPERSIZE_C4_ENVELOPE  = 30
PAPERSIZE_C5_ENVELOPE  = 28
PAPERSIZE_C65_ENVELOPE  = 32
PAPERSIZE_C6_ENVELOPE  = 31
PAPERSIZE_D  = 25
PAPERSIZE_DL_ENVELOPE  = 27
PAPERSIZE_E  = 26
PAPERSIZE_EXECUTIVE  = 7
PAPERSIZE_FOLIO  = 14
PAPERSIZE_GERMAN_LEGAL_FANFOLD  = 41
PAPERSIZE_GERMAN_STANDARD_FANFOLD  = 40
PAPERSIZE_INVITE_ENVELOPE  = 47
PAPERSIZE_ISO_B4  = 42
PAPERSIZE_ISO_B5_EXTRA_PAPER  = 63
PAPERSIZE_ITALY_ENVELOPE  = 36
PAPERSIZE_JAPANESE_DOUBLE_POSTCARD  = 43
PAPERSIZE_JIS_B5_TRANSVERSE_PAPER  = 60
PAPERSIZE_LEDGER  = 4
PAPERSIZE_LEGAL  = 5
PAPERSIZE_LEGAL_EXTRA_PAPER  = 49
PAPERSIZE_LETTER  = 1
PAPERSIZE_LETTER_EXTRA_PAPER  = 48
PAPERSIZE_LETTER_EXTRA_TRANSVERSE_PAPER  = 54
PAPERSIZE_LETTER_PLUS_PAPER  = 57
PAPERSIZE_LETTER_SMALL  = 2
PAPERSIZE_LETTER_TRANSVERSE_PAPER  = 52
PAPERSIZE_MONARCH_ENVELOPE  = 37
PAPERSIZE_NO10_ENVELOPE  = 20
PAPERSIZE_NO11_ENVELOPE  = 21
PAPERSIZE_NO12_ENVELOPE  = 22
PAPERSIZE_NO14_ENVELOPE  = 23
PAPERSIZE_NO9_ENVELOPE  = 19
PAPERSIZE_NOTE  = 18
PAPERSIZE_QUARTO  = 15
PAPERSIZE_STANDARD_1  = 16
PAPERSIZE_STANDARD_2  = 17
PAPERSIZE_STANDARD_PAPER_1  = 44
PAPERSIZE_STANDARD_PAPER_2  = 45
PAPERSIZE_STANDARD_PAPER_3  = 46
PAPERSIZE_STATEMENT  = 6
PAPERSIZE_SUPERA_SUPERA_A4_PAPER  = 55
PAPERSIZE_SUPERB_SUPERB_A3_PAPER  = 56
PAPERSIZE_TABLOID  = 3
PAPERSIZE_TABLOID_EXTRA_PAPER  = 50
PAPERSIZE_US_STANDARD_FANFOLD  = 39
SETPRINTRANGE_INSERT  = 'I'
SETPRINTRANGE_OVERWRITE  = 'O'

Properties

$columnsToRepeatAtLeft  : array<string|int, mixed>
Columns to repeat at left.
$firstPageNumber  : int|null
First page number.
$fitToHeight  : int|null
Fit To Height Number of vertical pages to fit on.
$fitToPage  : bool
Fit To Page Whether scale or fitToWith / fitToHeight applies.
$fitToWidth  : int|null
Fit To Width Number of horizontal pages to fit on.
$horizontalCentered  : bool
Center page horizontally.
$orientation  : string
Orientation.
$orientationDefault  : string
Orientation default.
$pageOrder  : string
$paperSize  : int|null
Paper size.
$paperSizeDefault  : int
Paper size default.
$printArea  : string|null
Print area.
$rowsToRepeatAtTop  : array<string|int, mixed>
Rows to repeat at top.
$scale  : int|null
Scale (Print Scale).
$verticalCentered  : bool
Center page vertically.

Methods

__construct()  : mixed
Create a new PageSetup.
addPrintArea()  : $this
Add a new print area (e.g. 'A1:D10' or 'A1:D10,G5:M20') to the list of print areas.
addPrintAreaByColumnAndRow()  : $this
Add a new print area to the list of print areas.
clearPrintArea()  : $this
Clear a print area.
getColumnsToRepeatAtLeft()  : array<string|int, mixed>
Get Columns to repeat at left.
getFirstPageNumber()  : int|null
Get first page number.
getFitToHeight()  : int|null
Get Fit To Height.
getFitToPage()  : bool
Get Fit To Page.
getFitToWidth()  : int|null
Get Fit To Width.
getHorizontalCentered()  : bool
Get center page horizontally.
getOrientation()  : string
Get Orientation.
getOrientationDefault()  : string
getPageOrder()  : string
getPaperSize()  : int
Get Paper Size.
getPaperSizeDefault()  : int
Get Paper Size default.
getPrintArea()  : string
Get print area.
getRowsToRepeatAtTop()  : array<string|int, mixed>
Get Rows to repeat at top.
getScale()  : int|null
Get Scale.
getVerticalCentered()  : bool
Get center page vertically.
isColumnsToRepeatAtLeftSet()  : bool
Is Columns to repeat at left set?
isPrintAreaSet()  : bool
Is print area set?
isRowsToRepeatAtTopSet()  : bool
Is Rows to repeat at top set?
resetFirstPageNumber()  : $this
Reset first page number.
setColumnsToRepeatAtLeft()  : $this
Set Columns to repeat at left.
setColumnsToRepeatAtLeftByStartAndEnd()  : $this
Set Columns to repeat at left by start and end.
setFirstPageNumber()  : $this
Set first page number.
setFitToHeight()  : $this
Set Fit To Height.
setFitToPage()  : $this
Set Fit To Page.
setFitToWidth()  : $this
Set Fit To Width.
setHorizontalCentered()  : $this
Set center page horizontally.
setOrientation()  : $this
Set Orientation.
setOrientationDefault()  : void
setPageOrder()  : self
setPaperSize()  : $this
Set Paper Size.
setPaperSizeDefault()  : void
Set Paper Size Default.
setPrintArea()  : $this
Set print area. e.g. 'A1:D10' or 'A1:D10,G5:M20'.
setPrintAreaByColumnAndRow()  : $this
Set print area.
setRowsToRepeatAtTop()  : $this
Set Rows to repeat at top.
setRowsToRepeatAtTopByStartAndEnd()  : $this
Set Rows to repeat at top by start and end.
setScale()  : $this
Set Scale.
setVerticalCentered()  : $this
Set center page vertically.

Constants

ORIENTATION_DEFAULT

public mixed ORIENTATION_DEFAULT = 'default'

ORIENTATION_LANDSCAPE

public mixed ORIENTATION_LANDSCAPE = 'landscape'

ORIENTATION_PORTRAIT

public mixed ORIENTATION_PORTRAIT = 'portrait'

PAGEORDER_DOWN_THEN_OVER

public mixed PAGEORDER_DOWN_THEN_OVER = 'downThenOver'

PAGEORDER_OVER_THEN_DOWN

public mixed PAGEORDER_OVER_THEN_DOWN = 'overThenDown'

PAPERSIZE_6_3_4_ENVELOPE

public mixed PAPERSIZE_6_3_4_ENVELOPE = 38

PAPERSIZE_A2_PAPER

public mixed PAPERSIZE_A2_PAPER = 64

PAPERSIZE_A3_EXTRA_PAPER

public mixed PAPERSIZE_A3_EXTRA_PAPER = 61

PAPERSIZE_A3_EXTRA_TRANSVERSE_PAPER

public mixed PAPERSIZE_A3_EXTRA_TRANSVERSE_PAPER = 66

PAPERSIZE_A3_TRANSVERSE_PAPER

public mixed PAPERSIZE_A3_TRANSVERSE_PAPER = 65

PAPERSIZE_A4_EXTRA_PAPER

public mixed PAPERSIZE_A4_EXTRA_PAPER = 51

PAPERSIZE_A4_PLUS_PAPER

public mixed PAPERSIZE_A4_PLUS_PAPER = 58

PAPERSIZE_A4_SMALL

public mixed PAPERSIZE_A4_SMALL = 10

PAPERSIZE_A4_TRANSVERSE_PAPER

public mixed PAPERSIZE_A4_TRANSVERSE_PAPER = 53

PAPERSIZE_A5_EXTRA_PAPER

public mixed PAPERSIZE_A5_EXTRA_PAPER = 62

PAPERSIZE_A5_TRANSVERSE_PAPER

public mixed PAPERSIZE_A5_TRANSVERSE_PAPER = 59

PAPERSIZE_B4_ENVELOPE

public mixed PAPERSIZE_B4_ENVELOPE = 33

PAPERSIZE_B5_ENVELOPE

public mixed PAPERSIZE_B5_ENVELOPE = 34

PAPERSIZE_B6_ENVELOPE

public mixed PAPERSIZE_B6_ENVELOPE = 35

PAPERSIZE_C3_ENVELOPE

public mixed PAPERSIZE_C3_ENVELOPE = 29

PAPERSIZE_C4_ENVELOPE

public mixed PAPERSIZE_C4_ENVELOPE = 30

PAPERSIZE_C5_ENVELOPE

public mixed PAPERSIZE_C5_ENVELOPE = 28

PAPERSIZE_C65_ENVELOPE

public mixed PAPERSIZE_C65_ENVELOPE = 32

PAPERSIZE_C6_ENVELOPE

public mixed PAPERSIZE_C6_ENVELOPE = 31

PAPERSIZE_DL_ENVELOPE

public mixed PAPERSIZE_DL_ENVELOPE = 27

PAPERSIZE_EXECUTIVE

public mixed PAPERSIZE_EXECUTIVE = 7

PAPERSIZE_FOLIO

public mixed PAPERSIZE_FOLIO = 14

PAPERSIZE_GERMAN_LEGAL_FANFOLD

public mixed PAPERSIZE_GERMAN_LEGAL_FANFOLD = 41

PAPERSIZE_GERMAN_STANDARD_FANFOLD

public mixed PAPERSIZE_GERMAN_STANDARD_FANFOLD = 40

PAPERSIZE_INVITE_ENVELOPE

public mixed PAPERSIZE_INVITE_ENVELOPE = 47

PAPERSIZE_ISO_B4

public mixed PAPERSIZE_ISO_B4 = 42

PAPERSIZE_ISO_B5_EXTRA_PAPER

public mixed PAPERSIZE_ISO_B5_EXTRA_PAPER = 63

PAPERSIZE_ITALY_ENVELOPE

public mixed PAPERSIZE_ITALY_ENVELOPE = 36

PAPERSIZE_JAPANESE_DOUBLE_POSTCARD

public mixed PAPERSIZE_JAPANESE_DOUBLE_POSTCARD = 43

PAPERSIZE_JIS_B5_TRANSVERSE_PAPER

public mixed PAPERSIZE_JIS_B5_TRANSVERSE_PAPER = 60

PAPERSIZE_LEDGER

public mixed PAPERSIZE_LEDGER = 4

PAPERSIZE_LEGAL

public mixed PAPERSIZE_LEGAL = 5

PAPERSIZE_LEGAL_EXTRA_PAPER

public mixed PAPERSIZE_LEGAL_EXTRA_PAPER = 49

PAPERSIZE_LETTER

public mixed PAPERSIZE_LETTER = 1

PAPERSIZE_LETTER_EXTRA_PAPER

public mixed PAPERSIZE_LETTER_EXTRA_PAPER = 48

PAPERSIZE_LETTER_EXTRA_TRANSVERSE_PAPER

public mixed PAPERSIZE_LETTER_EXTRA_TRANSVERSE_PAPER = 54

PAPERSIZE_LETTER_PLUS_PAPER

public mixed PAPERSIZE_LETTER_PLUS_PAPER = 57

PAPERSIZE_LETTER_SMALL

public mixed PAPERSIZE_LETTER_SMALL = 2

PAPERSIZE_LETTER_TRANSVERSE_PAPER

public mixed PAPERSIZE_LETTER_TRANSVERSE_PAPER = 52

PAPERSIZE_MONARCH_ENVELOPE

public mixed PAPERSIZE_MONARCH_ENVELOPE = 37

PAPERSIZE_NO10_ENVELOPE

public mixed PAPERSIZE_NO10_ENVELOPE = 20

PAPERSIZE_NO11_ENVELOPE

public mixed PAPERSIZE_NO11_ENVELOPE = 21

PAPERSIZE_NO12_ENVELOPE

public mixed PAPERSIZE_NO12_ENVELOPE = 22

PAPERSIZE_NO14_ENVELOPE

public mixed PAPERSIZE_NO14_ENVELOPE = 23

PAPERSIZE_NO9_ENVELOPE

public mixed PAPERSIZE_NO9_ENVELOPE = 19

PAPERSIZE_NOTE

public mixed PAPERSIZE_NOTE = 18

PAPERSIZE_QUARTO

public mixed PAPERSIZE_QUARTO = 15

PAPERSIZE_STANDARD_1

public mixed PAPERSIZE_STANDARD_1 = 16

PAPERSIZE_STANDARD_2

public mixed PAPERSIZE_STANDARD_2 = 17

PAPERSIZE_STANDARD_PAPER_1

public mixed PAPERSIZE_STANDARD_PAPER_1 = 44

PAPERSIZE_STANDARD_PAPER_2

public mixed PAPERSIZE_STANDARD_PAPER_2 = 45

PAPERSIZE_STANDARD_PAPER_3

public mixed PAPERSIZE_STANDARD_PAPER_3 = 46

PAPERSIZE_STATEMENT

public mixed PAPERSIZE_STATEMENT = 6

PAPERSIZE_SUPERA_SUPERA_A4_PAPER

public mixed PAPERSIZE_SUPERA_SUPERA_A4_PAPER = 55

PAPERSIZE_SUPERB_SUPERB_A3_PAPER

public mixed PAPERSIZE_SUPERB_SUPERB_A3_PAPER = 56

PAPERSIZE_TABLOID

public mixed PAPERSIZE_TABLOID = 3

PAPERSIZE_TABLOID_EXTRA_PAPER

public mixed PAPERSIZE_TABLOID_EXTRA_PAPER = 50

PAPERSIZE_US_STANDARD_FANFOLD

public mixed PAPERSIZE_US_STANDARD_FANFOLD = 39

SETPRINTRANGE_INSERT

public mixed SETPRINTRANGE_INSERT = 'I'

SETPRINTRANGE_OVERWRITE

public mixed SETPRINTRANGE_OVERWRITE = 'O'

Properties

$columnsToRepeatAtLeft

Columns to repeat at left.

private array<string|int, mixed> $columnsToRepeatAtLeft = ['', '']

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

$firstPageNumber

First page number.

private int|null $firstPageNumber = null

$fitToHeight

Fit To Height Number of vertical pages to fit on.

private int|null $fitToHeight = 1

$fitToPage

Fit To Page Whether scale or fitToWith / fitToHeight applies.

private bool $fitToPage = false

$fitToWidth

Fit To Width Number of horizontal pages to fit on.

private int|null $fitToWidth = 1

$horizontalCentered

Center page horizontally.

private bool $horizontalCentered = false

$orientation

Orientation.

private string $orientation

$orientationDefault

Orientation default.

private static string $orientationDefault = self::ORIENTATION_DEFAULT

$pageOrder

private string $pageOrder = self::PAGEORDER_DOWN_THEN_OVER

$paperSize

Paper size.

private int|null $paperSize = null

$paperSizeDefault

Paper size default.

private static int $paperSizeDefault = self::PAPERSIZE_LETTER

$printArea

Print area.

private string|null $printArea = null

$rowsToRepeatAtTop

Rows to repeat at top.

private array<string|int, mixed> $rowsToRepeatAtTop = [0, 0]

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

$scale

Scale (Print Scale).

private int|null $scale = 100

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

$verticalCentered

Center page vertically.

private bool $verticalCentered = false

Methods

__construct()

Create a new PageSetup.

public __construct() : mixed

addPrintArea()

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

public addPrintArea(string $value[, int $index = -1 ]) : $this
Parameters
$value : string
$index : int = -1

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 values
$this

addPrintAreaByColumnAndRow()

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

public addPrintAreaByColumnAndRow(int $column1, int $row1, int $column2, int $row2[, int $index = -1 ]) : $this
Parameters
$column1 : int

Start Column for the print area

$row1 : int

Start Row for the print area

$column2 : int

End Column for the print area

$row2 : int

End Row for the print area

$index : int = -1

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 values
$this

clearPrintArea()

Clear a print area.

public clearPrintArea([int $index = 0 ]) : $this
Parameters
$index : int = 0

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 values
$this

getColumnsToRepeatAtLeft()

Get Columns to repeat at left.

public getColumnsToRepeatAtLeft() : array<string|int, mixed>
Return values
array<string|int, mixed> —

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

getFirstPageNumber()

Get first page number.

public getFirstPageNumber() : int|null
Return values
int|null

getFitToHeight()

Get Fit To Height.

public getFitToHeight() : int|null
Return values
int|null

getFitToPage()

Get Fit To Page.

public getFitToPage() : bool
Return values
bool

getFitToWidth()

Get Fit To Width.

public getFitToWidth() : int|null
Return values
int|null

getHorizontalCentered()

Get center page horizontally.

public getHorizontalCentered() : bool
Return values
bool

getOrientation()

Get Orientation.

public getOrientation() : string
Return values
string

getOrientationDefault()

public static getOrientationDefault() : string
Return values
string

getPageOrder()

public getPageOrder() : string
Return values
string

getPaperSize()

Get Paper Size.

public getPaperSize() : int
Return values
int

getPaperSizeDefault()

Get Paper Size default.

public static getPaperSizeDefault() : int
Return values
int

getPrintArea()

Get print area.

public getPrintArea([int $index = 0 ]) : string
Parameters
$index : int = 0

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 values
string

getRowsToRepeatAtTop()

Get Rows to repeat at top.

public getRowsToRepeatAtTop() : array<string|int, mixed>
Return values
array<string|int, mixed> —

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

getScale()

Get Scale.

public getScale() : int|null
Return values
int|null

getVerticalCentered()

Get center page vertically.

public getVerticalCentered() : bool
Return values
bool

isColumnsToRepeatAtLeftSet()

Is Columns to repeat at left set?

public isColumnsToRepeatAtLeftSet() : bool
Return values
bool

isPrintAreaSet()

Is print area set?

public isPrintAreaSet([int $index = 0 ]) : bool
Parameters
$index : int = 0

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 values
bool

isRowsToRepeatAtTopSet()

Is Rows to repeat at top set?

public isRowsToRepeatAtTopSet() : bool
Return values
bool

resetFirstPageNumber()

Reset first page number.

public resetFirstPageNumber() : $this
Return values
$this

setColumnsToRepeatAtLeft()

Set Columns to repeat at left.

public setColumnsToRepeatAtLeft(array<string|int, mixed> $columnsToRepeatAtLeft) : $this
Parameters
$columnsToRepeatAtLeft : array<string|int, mixed>

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

Return values
$this

setColumnsToRepeatAtLeftByStartAndEnd()

Set Columns to repeat at left by start and end.

public setColumnsToRepeatAtLeftByStartAndEnd(string $start, string $end) : $this
Parameters
$start : string

eg: 'A'

$end : string

eg: 'B'

Return values
$this

setFirstPageNumber()

Set first page number.

public setFirstPageNumber(int|null $value) : $this
Parameters
$value : int|null
Return values
$this

setFitToHeight()

Set Fit To Height.

public setFitToHeight(int|null $fitToHeight[, bool $update = true ]) : $this
Parameters
$fitToHeight : int|null
$update : bool = true

Update fitToPage so it applies rather than scaling

Return values
$this

setFitToPage()

Set Fit To Page.

public setFitToPage(bool $fitToPage) : $this
Parameters
$fitToPage : bool
Return values
$this

setFitToWidth()

Set Fit To Width.

public setFitToWidth(int|null $value[, bool $update = true ]) : $this
Parameters
$value : int|null
$update : bool = true

Update fitToPage so it applies rather than scaling

Return values
$this

setHorizontalCentered()

Set center page horizontally.

public setHorizontalCentered(bool $value) : $this
Parameters
$value : bool
Return values
$this

setOrientation()

Set Orientation.

public setOrientation(string $orientation) : $this
Parameters
$orientation : string

see self::ORIENTATION_*

Return values
$this

setOrientationDefault()

public static setOrientationDefault(string $orientation) : void
Parameters
$orientation : string

setPageOrder()

public setPageOrder(string|null $pageOrder) : self
Parameters
$pageOrder : string|null
Return values
self

setPaperSize()

Set Paper Size.

public setPaperSize(int $paperSize) : $this
Parameters
$paperSize : int

see self::PAPERSIZE_*

Return values
$this

setPaperSizeDefault()

Set Paper Size Default.

public static setPaperSizeDefault(int $paperSize) : void
Parameters
$paperSize : int

setPrintArea()

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

public setPrintArea(string $value[, int $index = 0 ][, string $method = self::SETPRINTRANGE_OVERWRITE ]) : $this
Parameters
$value : string
$index : int = 0

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

$method : string = self::SETPRINTRANGE_OVERWRITE

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 values
$this

setPrintAreaByColumnAndRow()

Set print area.

public setPrintAreaByColumnAndRow(int $column1, int $row1, int $column2, int $row2[, int $index = 0 ][, string $method = self::SETPRINTRANGE_OVERWRITE ]) : $this
Parameters
$column1 : int

Column 1

$row1 : int

Row 1

$column2 : int

Column 2

$row2 : int

Row 2

$index : int = 0

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

$method : string = self::SETPRINTRANGE_OVERWRITE

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 values
$this

setRowsToRepeatAtTop()

Set Rows to repeat at top.

public setRowsToRepeatAtTop(array<string|int, mixed> $rowsToRepeatAtTop) : $this
Parameters
$rowsToRepeatAtTop : array<string|int, mixed>

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

Return values
$this

setRowsToRepeatAtTopByStartAndEnd()

Set Rows to repeat at top by start and end.

public setRowsToRepeatAtTopByStartAndEnd(int $start, int $end) : $this
Parameters
$start : int

eg: 1

$end : int

eg: 1

Return values
$this

setScale()

Set Scale.

public setScale(int|null $scale[, bool $update = true ]) : $this

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

Parameters
$scale : int|null
$update : bool = true

Update fitToPage so scaling applies rather than fitToHeight / fitToWidth

Return values
$this

setVerticalCentered()

Set center page vertically.

public setVerticalCentered(bool $value) : $this
Parameters
$value : bool
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results