Overview

Packages

  • JAMA
  • None
  • PHP
  • PHPExcel
    • CachedObjectStorage
    • Calculation
    • Cell
    • Chart
      • Renderer
    • Reader
      • Excel2007
      • Excel5
    • RichText
    • Settings
    • Shared
      • Escher
      • OLE
      • Trend
      • ZipArchive
    • Style
    • Worksheet
      • Drawing
    • Writer
      • 2007
      • CSV
      • Excel2007
      • Excel5
      • HTML
      • PDF

Classes

  • PHPExcel_Worksheet
  • PHPExcel_Worksheet_AutoFilter
  • PHPExcel_Worksheet_AutoFilter_Column
  • PHPExcel_Worksheet_AutoFilter_Column_Rule
  • PHPExcel_Worksheet_BaseDrawing
  • PHPExcel_Worksheet_CellIterator
  • PHPExcel_Worksheet_ColumnDimension
  • PHPExcel_Worksheet_HeaderFooter
  • PHPExcel_Worksheet_HeaderFooterDrawing
  • PHPExcel_Worksheet_MemoryDrawing
  • PHPExcel_Worksheet_PageMargins
  • PHPExcel_Worksheet_PageSetup
  • PHPExcel_Worksheet_Protection
  • PHPExcel_Worksheet_Row
  • PHPExcel_Worksheet_RowDimension
  • PHPExcel_Worksheet_RowIterator
  • PHPExcel_Worksheet_SheetView
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Class PHPExcel_Worksheet_PageSetup

PHPExcel_Worksheet_PageSetup

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)
Package: PHPExcel\Worksheet
Category: PHPExcel
Copyright: Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
License: LGPL
Located at controlador/include/phpexcel/PHPExcel/Worksheet/PageSetup.php
Methods summary
public
# __construct( )

Create a new PHPExcel_Worksheet_PageSetup

Create a new PHPExcel_Worksheet_PageSetup

public integer
# getPaperSize( )

Get Paper Size

Get Paper Size

Returns

integer
public PHPExcel_Worksheet_PageSetup
# setPaperSize( integer $pValue = PHPExcel_Worksheet_PageSetup::PAPERSIZE_LETTER )

Set Paper Size

Set Paper Size

Parameters

$pValue

Returns

PHPExcel_Worksheet_PageSetup
public string
# getOrientation( )

Get Orientation

Get Orientation

Returns

string
public PHPExcel_Worksheet_PageSetup
# setOrientation( string $pValue = PHPExcel_Worksheet_PageSetup::ORIENTATION_DEFAULT )

Set Orientation

Set Orientation

Parameters

$pValue

Returns

PHPExcel_Worksheet_PageSetup
public int?
# getScale( )

Get Scale

Get Scale

Returns

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

Set Scale

Set Scale

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

Parameters

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

Returns

PHPExcel_Worksheet_PageSetup

Throws

PHPExcel_Exception
public boolean
# getFitToPage( )

Get Fit To Page

Get Fit To Page

Returns

boolean
public PHPExcel_Worksheet_PageSetup
# setFitToPage( boolean $pValue = TRUE )

Set Fit To Page

Set Fit To Page

Parameters

$pValue

Returns

PHPExcel_Worksheet_PageSetup
public int?
# getFitToHeight( )

Get Fit To Height

Get Fit To Height

Returns

int?
public PHPExcel_Worksheet_PageSetup
# setFitToHeight( int? $pValue = 1, boolean $pUpdate = TRUE )

Set Fit To Height

Set Fit To Height

Parameters

$pValue
$pUpdate
Update fitToPage so it applies rather than scaling

Returns

PHPExcel_Worksheet_PageSetup
public int?
# getFitToWidth( )

Get Fit To Width

Get Fit To Width

Returns

int?
public PHPExcel_Worksheet_PageSetup
# setFitToWidth( int? $pValue = 1, boolean $pUpdate = TRUE )

Set Fit To Width

Set Fit To Width

Parameters

$pValue
$pUpdate
Update fitToPage so it applies rather than scaling

Returns

PHPExcel_Worksheet_PageSetup
public boolean
# isColumnsToRepeatAtLeftSet( )

Is Columns to repeat at left set?

Is Columns to repeat at left set?

Returns

boolean
public array
# getColumnsToRepeatAtLeft( )

Get Columns to repeat at left

Get Columns to repeat at left

Returns

array
Containing start column and end column, empty array if option unset
public PHPExcel_Worksheet_PageSetup
# setColumnsToRepeatAtLeft( array $pValue = null )

Set Columns to repeat at left

Set Columns to repeat at left

Parameters

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

Returns

PHPExcel_Worksheet_PageSetup
public PHPExcel_Worksheet_PageSetup
# setColumnsToRepeatAtLeftByStartAndEnd( string $pStart = 'A', string $pEnd = 'A' )

Set Columns to repeat at left by start and end

Set Columns to repeat at left by start and end

Parameters

$pStart
$pEnd

Returns

PHPExcel_Worksheet_PageSetup
public boolean
# isRowsToRepeatAtTopSet( )

Is Rows to repeat at top set?

Is Rows to repeat at top set?

Returns

boolean
public array
# getRowsToRepeatAtTop( )

Get Rows to repeat at top

Get Rows to repeat at top

Returns

array
Containing start column and end column, empty array if option unset
public PHPExcel_Worksheet_PageSetup
# setRowsToRepeatAtTop( array $pValue = null )

Set Rows to repeat at top

Set Rows to repeat at top

Parameters

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

Returns

PHPExcel_Worksheet_PageSetup
public PHPExcel_Worksheet_PageSetup
# setRowsToRepeatAtTopByStartAndEnd( integer $pStart = 1, integer $pEnd = 1 )

Set Rows to repeat at top by start and end

Set Rows to repeat at top by start and end

Parameters

$pStart
$pEnd

Returns

PHPExcel_Worksheet_PageSetup
public boolean
# getHorizontalCentered( )

Get center page horizontally

Get center page horizontally

Returns

boolean
public PHPExcel_Worksheet_PageSetup
# setHorizontalCentered( boolean $value = false )

Set center page horizontally

Set center page horizontally

Parameters

$value

Returns

PHPExcel_Worksheet_PageSetup
public boolean
# getVerticalCentered( )

Get center page vertically

Get center page vertically

Returns

boolean
public PHPExcel_Worksheet_PageSetup
# setVerticalCentered( boolean $value = false )

Set center page vertically

Set center page vertically

Parameters

$value

Returns

PHPExcel_Worksheet_PageSetup
public string
# getPrintArea( integer $index = 0 )

Get print area

Get print area

Parameters

$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

Throws

PHPExcel_Exception
public boolean
# isPrintAreaSet( integer $index = 0 )

Is print area set?

Is print area set?

Parameters

$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
public PHPExcel_Worksheet_PageSetup
# clearPrintArea( integer $index = 0 )

Clear a print area

Clear a print area

Parameters

$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

PHPExcel_Worksheet_PageSetup
public PHPExcel_Worksheet_PageSetup
# setPrintArea( string $value, integer $index = 0, string $method = PHPExcel_Worksheet_PageSetup::SETPRINTRANGE_OVERWRITE )

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

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

Parameters

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

$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

PHPExcel_Worksheet_PageSetup

Throws

PHPExcel_Exception
public PHPExcel_Worksheet_PageSetup
# addPrintArea( string $value, integer $index = -1 )

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

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

Parameters

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

PHPExcel_Worksheet_PageSetup

Throws

PHPExcel_Exception
public PHPExcel_Worksheet_PageSetup
# setPrintAreaByColumnAndRow( integer $column1, integer $row1, integer $column2, integer $row2, integer $index = 0, string $method = PHPExcel_Worksheet_PageSetup::SETPRINTRANGE_OVERWRITE )

Set print area

Set print area

Parameters

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

$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

PHPExcel_Worksheet_PageSetup

Throws

PHPExcel_Exception
public PHPExcel_Worksheet_PageSetup
# addPrintAreaByColumnAndRow( integer $column1, integer $row1, integer $column2, integer $row2, integer $index = -1 )

Add a new print area to the list of print areas

Add a new print area to the list of print areas

Parameters

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

PHPExcel_Worksheet_PageSetup

Throws

PHPExcel_Exception
public integer
# getFirstPageNumber( )

Get first page number

Get first page number

Returns

integer
public PHPExcel_Worksheet_HeaderFooter
# setFirstPageNumber( integer $value = null )

Set first page number

Set first page number

Parameters

$value

Returns

PHPExcel_Worksheet_HeaderFooter
public PHPExcel_Worksheet_HeaderFooter
# resetFirstPageNumber( )

Reset first page number

Reset first page number

Returns

PHPExcel_Worksheet_HeaderFooter
public
# __clone( )

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

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

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

Paper size

Paper size

# PHPExcel_Worksheet_PageSetup::PAPERSIZE_LETTER
private string $_orientation

Orientation

Orientation

# PHPExcel_Worksheet_PageSetup::ORIENTATION_DEFAULT
private int? $_scale

Scale (Print Scale)

Scale (Print Scale)

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

# 100
private boolean $_fitToPage

Fit To Page Whether scale or fitToWith / fitToHeight applies

Fit To Page Whether scale or fitToWith / fitToHeight applies

# FALSE
private int? $_fitToHeight

Fit To Height Number of vertical pages to fit on

Fit To Height Number of vertical pages to fit on

# 1
private int? $_fitToWidth

Fit To Width Number of horizontal pages to fit on

Fit To Width Number of horizontal pages to fit on

# 1
private array $_columnsToRepeatAtLeft

Columns to repeat at left

Columns to repeat at left

# array('', '')
private array $_rowsToRepeatAtTop

Rows to repeat at top

Rows to repeat at top

# array(0, 0)
private boolean $_horizontalCentered

Center page horizontally

Center page horizontally

# FALSE
private boolean $_verticalCentered

Center page vertically

Center page vertically

# FALSE
private string $_printArea

Print area

Print area

# NULL
private integer $_firstPageNumber

First page number

First page number

# NULL
Autene API documentation generated by ApiGen