\PHPExcel_Worksheet_HeaderFooter

PHPExcel_Worksheet_HeaderFooter

Header/Footer Formatting Syntax taken from Office Open XML Part 4 - Markup Language Reference, page 1970:


There are a number of formatting codes that can be written inline with the actual header / footer text, which
affect the formatting in the header or footer.
Example: This example shows the text "Center Bold Header" on the first line (center section), and the date on
the second line (center section).
&CCenter &"-,Bold"Bold&"-,Regular"Headerx000A&D
General Rules:
There is no required order in which these codes must appear.
The first occurrence of the following codes turns the formatting ON, the second occurrence turns it OFF again:

strikethrough
superscript
subscript
Superscript and subscript cannot both be ON at same time. Whichever comes first wins and the other is ignored,
while the first is ON.
&L - code for "left section" (there are three header / footer locations, "left", "center", and "right"). When
two or more occurrences of this section marker exist, the contents from all markers are concatenated, in the
order of appearance, and placed into the left section.
&P - code for "current page #"
&N - code for "total pages"
&font size - code for "text font size", where font size is a font size in points.
&K - code for "text font color"
RGB Color is specified as RRGGBB
Theme Color is specifed as TTSNN where TT is the theme color Id, S is either "+" or "-" of the tint/shade
value, NN is the tint/shade value.
&S - code for "text strikethrough" on / off
&X - code for "text super script" on / off
&Y - code for "text subscript" on / off
&C - code for "center section". When two or more occurrences of this section marker exist, the contents
from all markers are concatenated, in the order of appearance, and placed into the center section.

&D - code for "date" &T - code for "time" &G - code for "picture as background" &U - code for "text single underline" &E - code for "double underline" &R - code for "right section". When two or more occurrences of this section marker exist, the contents from all markers are concatenated, in the order of appearance, and placed into the right section. &Z - code for "this workbook's file path" &F - code for "this workbook's file name" &A - code for "sheet tab name" &+ - code for add to page #. &- - code for subtract from page #. &"font name,font type" - code for "text font name" and "text font type", where font name and font type are strings specifying the name and type of the font, separated by a comma. When a hyphen appears in font name, it means "none specified". Both of font name and font type can be localized values. &"-,Bold" - code for "bold font style" &B - also means "bold font style". &"-,Regular" - code for "regular font style" &"-,Italic" - code for "italic font style" &I - also means "italic font style" &"-,Bold Italic" code for "bold italic font style" &O - code for "outline style" &H - code for "shadow style"

Summary

Methods

Properties

Constants

__construct()
getOddHeader()
setOddHeader()
getOddFooter()
setOddFooter()
getEvenHeader()
setEvenHeader()
getEvenFooter()
setEvenFooter()
getFirstHeader()
setFirstHeader()
getFirstFooter()
setFirstFooter()
getDifferentOddEven()
setDifferentOddEven()
getDifferentFirst()
setDifferentFirst()
getScaleWithDocument()
setScaleWithDocument()
getAlignWithMargins()
setAlignWithMargins()
addImage()
removeImage()
setImages()
getImages()
__clone()

No public properties found

IMAGE_HEADER_LEFT
IMAGE_HEADER_CENTER
IMAGE_HEADER_RIGHT
IMAGE_FOOTER_LEFT
IMAGE_FOOTER_CENTER
IMAGE_FOOTER_RIGHT

No protected methods found

No protected properties found

N/A

No private methods found

$_oddHeader
$_oddFooter
$_evenHeader
$_evenFooter
$_firstHeader
$_firstFooter
$_differentOddEven
$_differentFirst
$_scaleWithDocument
$_alignWithMargins
$_headerFooterImages

N/A

File: framework/library/phpexcel/PHPExcel/Worksheet/HeaderFooter.php
Package: PHPExcel_Worksheet
Class hierarchy: \PHPExcel_Worksheet_HeaderFooter

Constants

IMAGE_HEADER_LEFT

IMAGE_HEADER_LEFT = 'LH'

IMAGE_HEADER_CENTER

IMAGE_HEADER_CENTER = 'CH'

IMAGE_HEADER_RIGHT

IMAGE_HEADER_RIGHT = 'RH'

IMAGE_FOOTER_LEFT

IMAGE_FOOTER_LEFT = 'LF'

IMAGE_FOOTER_CENTER

IMAGE_FOOTER_CENTER = 'CF'

IMAGE_FOOTER_RIGHT

IMAGE_FOOTER_RIGHT = 'RF'

Properties

$_oddHeader

$_oddHeader : string

OddHeader

Type

string

$_oddFooter

$_oddFooter : string

OddFooter

Type

string

$_evenHeader

$_evenHeader : string

EvenHeader

Type

string

$_evenFooter

$_evenFooter : string

EvenFooter

Type

string

$_firstHeader

$_firstHeader : string

FirstHeader

Type

string

$_firstFooter

$_firstFooter : string

FirstFooter

Type

string

$_differentOddEven

$_differentOddEven : boolean

Different header for Odd/Even, defaults to false

Type

boolean

$_differentFirst

$_differentFirst : boolean

Different header for first page, defaults to false

Type

boolean

$_scaleWithDocument

$_scaleWithDocument : boolean

Scale with document, defaults to true

Type

boolean

$_alignWithMargins

$_alignWithMargins : boolean

Align with margins, defaults to true

Type

boolean

$_headerFooterImages

$_headerFooterImages : array<mixed,\PHPExcel_Worksheet_HeaderFooterDrawing>

Header/footer images

Type

array<mixed,\PHPExcel_Worksheet_HeaderFooterDrawing>

Methods

__construct()

__construct()

Create a new PHPExcel_Worksheet_HeaderFooter

getOddHeader()

getOddHeader() : string

Get OddHeader

Returns

string

setOddHeader()

setOddHeader(string  $pValue) : \PHPExcel_Worksheet_HeaderFooter

Set OddHeader

Parameters

string

$pValue

Returns

\PHPExcel_Worksheet_HeaderFooter

getOddFooter()

getOddFooter() : string

Get OddFooter

Returns

string

setOddFooter()

setOddFooter(string  $pValue) : \PHPExcel_Worksheet_HeaderFooter

Set OddFooter

Parameters

string

$pValue

Returns

\PHPExcel_Worksheet_HeaderFooter

getEvenHeader()

getEvenHeader() : string

Get EvenHeader

Returns

string

setEvenHeader()

setEvenHeader(string  $pValue) : \PHPExcel_Worksheet_HeaderFooter

Set EvenHeader

Parameters

string

$pValue

Returns

\PHPExcel_Worksheet_HeaderFooter

getEvenFooter()

getEvenFooter() : string

Get EvenFooter

Returns

string

setEvenFooter()

setEvenFooter(string  $pValue) : \PHPExcel_Worksheet_HeaderFooter

Set EvenFooter

Parameters

string

$pValue

Returns

\PHPExcel_Worksheet_HeaderFooter

getFirstHeader()

getFirstHeader() : string

Get FirstHeader

Returns

string

setFirstHeader()

setFirstHeader(string  $pValue) : \PHPExcel_Worksheet_HeaderFooter

Set FirstHeader

Parameters

string

$pValue

Returns

\PHPExcel_Worksheet_HeaderFooter

getFirstFooter()

getFirstFooter() : string

Get FirstFooter

Returns

string

setFirstFooter()

setFirstFooter(string  $pValue) : \PHPExcel_Worksheet_HeaderFooter

Set FirstFooter

Parameters

string

$pValue

Returns

\PHPExcel_Worksheet_HeaderFooter

getDifferentOddEven()

getDifferentOddEven() : boolean

Get DifferentOddEven

Returns

boolean

setDifferentOddEven()

setDifferentOddEven(boolean  $pValue = false) : \PHPExcel_Worksheet_HeaderFooter

Set DifferentOddEven

Parameters

boolean

$pValue

Returns

\PHPExcel_Worksheet_HeaderFooter

getDifferentFirst()

getDifferentFirst() : boolean

Get DifferentFirst

Returns

boolean

setDifferentFirst()

setDifferentFirst(boolean  $pValue = false) : \PHPExcel_Worksheet_HeaderFooter

Set DifferentFirst

Parameters

boolean

$pValue

Returns

\PHPExcel_Worksheet_HeaderFooter

getScaleWithDocument()

getScaleWithDocument() : boolean

Get ScaleWithDocument

Returns

boolean

setScaleWithDocument()

setScaleWithDocument(boolean  $pValue = true) : \PHPExcel_Worksheet_HeaderFooter

Set ScaleWithDocument

Parameters

boolean

$pValue

Returns

\PHPExcel_Worksheet_HeaderFooter

getAlignWithMargins()

getAlignWithMargins() : boolean

Get AlignWithMargins

Returns

boolean

setAlignWithMargins()

setAlignWithMargins(boolean  $pValue = true) : \PHPExcel_Worksheet_HeaderFooter

Set AlignWithMargins

Parameters

boolean

$pValue

Returns

\PHPExcel_Worksheet_HeaderFooter

addImage()

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

Add header/footer image

Parameters

\PHPExcel_Worksheet_HeaderFooterDrawing	$image
string	$location

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_HeaderFooter

removeImage()

removeImage(string  $location = self::IMAGE_HEADER_LEFT) : \PHPExcel_Worksheet_HeaderFooter

Remove header/footer image

Parameters

string

$location

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_HeaderFooter

setImages()

setImages(array<mixed,\PHPExcel_Worksheet_HeaderFooterDrawing>  $images) : \PHPExcel_Worksheet_HeaderFooter

Set header/footer images

Parameters

array<mixed,\PHPExcel_Worksheet_HeaderFooterDrawing>

$images

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_HeaderFooter

getImages()

getImages() : array<mixed,\PHPExcel_Worksheet_HeaderFooterDrawing>

Get header/footer images

Returns

array<mixed,\PHPExcel_Worksheet_HeaderFooterDrawing>

__clone()

__clone()

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

category	PHPExcel
copyright	Copyright (c) 2006 - 2013 PHPExcel (http://www.codeplex.com/PHPExcel)