class PHPExcel_Worksheet_HeaderFooter

PHPExcelWorksheetHeaderFooter

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not,241 write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Constants

IMAGE_HEADER_LEFT

IMAGE_HEADER_CENTER

IMAGE_HEADER_RIGHT

IMAGE_FOOTER_LEFT

IMAGE_FOOTER_CENTER

IMAGE_FOOTER_RIGHT

Methods

__construct()

Create a new PHPExcelWorksheetHeaderFooter

string
getOddHeader()

Get OddHeader

setOddHeader(string $pValue)

Set OddHeader

string
getOddFooter()

Get OddFooter

setOddFooter(string $pValue)

Set OddFooter

string
getEvenHeader()

Get EvenHeader

setEvenHeader(string $pValue)

Set EvenHeader

string
getEvenFooter()

Get EvenFooter

setEvenFooter(string $pValue)

Set EvenFooter

string
getFirstHeader()

Get FirstHeader

setFirstHeader(string $pValue)

Set FirstHeader

string
getFirstFooter()

Get FirstFooter

setFirstFooter(string $pValue)

Set FirstFooter

boolean
getDifferentOddEven()

Get DifferentOddEven

setDifferentOddEven(boolean $pValue = false)

Set DifferentOddEven

boolean
getDifferentFirst()

Get DifferentFirst

setDifferentFirst(boolean $pValue = false)

Set DifferentFirst

boolean
getScaleWithDocument()

Get ScaleWithDocument

setScaleWithDocument(boolean $pValue = true)

Set ScaleWithDocument

boolean
getAlignWithMargins()

Get AlignWithMargins

setAlignWithMargins(boolean $pValue = true)

Set AlignWithMargins

addImage(PHPExcel_Worksheet_HeaderFooterDrawing $image = null, string $location = self::IMAGE_HEADER_LEFT)

Add header/footer image

removeImage(string $location = self::IMAGE_HEADER_LEFT)

Remove header/footer image

getImages()

Get header/footer images

__clone()

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

Details

at line 187
__construct()

Create a new PHPExcelWorksheetHeaderFooter

at line 196
string getOddHeader()

Get OddHeader

Return Value

string

at line 207
PHPExcel_Worksheet_HeaderFooter setOddHeader(string $pValue)

Set OddHeader

Parameters

string $pValue

Return Value

PHPExcel_Worksheet_HeaderFooter

at line 218
string getOddFooter()

Get OddFooter

Return Value

string

at line 229
PHPExcel_Worksheet_HeaderFooter setOddFooter(string $pValue)

Set OddFooter

Parameters

string $pValue

Return Value

PHPExcel_Worksheet_HeaderFooter

at line 240
string getEvenHeader()

Get EvenHeader

Return Value

string

at line 251
PHPExcel_Worksheet_HeaderFooter setEvenHeader(string $pValue)

Set EvenHeader

Parameters

string $pValue

Return Value

PHPExcel_Worksheet_HeaderFooter

at line 262
string getEvenFooter()

Get EvenFooter

Return Value

string

at line 273
PHPExcel_Worksheet_HeaderFooter setEvenFooter(string $pValue)

Set EvenFooter

Parameters

string $pValue

Return Value

PHPExcel_Worksheet_HeaderFooter

at line 284
string getFirstHeader()

Get FirstHeader

Return Value

string

at line 295
PHPExcel_Worksheet_HeaderFooter setFirstHeader(string $pValue)

Set FirstHeader

Parameters

string $pValue

Return Value

PHPExcel_Worksheet_HeaderFooter

at line 306
string getFirstFooter()

Get FirstFooter

Return Value

string

at line 317
PHPExcel_Worksheet_HeaderFooter setFirstFooter(string $pValue)

Set FirstFooter

Parameters

string $pValue

Return Value

PHPExcel_Worksheet_HeaderFooter

at line 328
boolean getDifferentOddEven()

Get DifferentOddEven

Return Value

boolean

at line 339
PHPExcel_Worksheet_HeaderFooter setDifferentOddEven(boolean $pValue = false)

Set DifferentOddEven

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_HeaderFooter

at line 350
boolean getDifferentFirst()

Get DifferentFirst

Return Value

boolean

at line 361
PHPExcel_Worksheet_HeaderFooter setDifferentFirst(boolean $pValue = false)

Set DifferentFirst

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_HeaderFooter

at line 372
boolean getScaleWithDocument()

Get ScaleWithDocument

Return Value

boolean

at line 383
PHPExcel_Worksheet_HeaderFooter setScaleWithDocument(boolean $pValue = true)

Set ScaleWithDocument

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_HeaderFooter

at line 394
boolean getAlignWithMargins()

Get AlignWithMargins

Return Value

boolean

at line 405
PHPExcel_Worksheet_HeaderFooter setAlignWithMargins(boolean $pValue = true)

Set AlignWithMargins

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_HeaderFooter

at line 419
PHPExcel_Worksheet_HeaderFooter addImage(PHPExcel_Worksheet_HeaderFooterDrawing $image = null, string $location = self::IMAGE_HEADER_LEFT)

Add header/footer image

Parameters

PHPExcel_Worksheet_HeaderFooterDrawing $image
string $location

Return Value

PHPExcel_Worksheet_HeaderFooter

Exceptions

PHPExcel_Exception

at line 432
PHPExcel_Worksheet_HeaderFooter removeImage(string $location = self::IMAGE_HEADER_LEFT)

Remove header/footer image

Parameters

string $location

Return Value

PHPExcel_Worksheet_HeaderFooter

Exceptions

PHPExcel_Exception

at line 447
PHPExcel_Worksheet_HeaderFooter setImages(PHPExcel_Worksheet_HeaderFooterDrawing[] $images)

Set header/footer images

at line 462
PHPExcel_Worksheet_HeaderFooterDrawing[] getImages()

Get header/footer images

at line 492
__clone()

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