\PhpOffice\PhpSpreadsheet\WorksheetHeaderFooter

<code> 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"Header_x000A_&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

Constants

IMAGE_HEADER_LEFT

IMAGE_HEADER_LEFT = 'LH'

IMAGE_HEADER_CENTER

IMAGE_HEADER_CENTER = 'CH'

IMAGE_HEADER_RIGHT

IMAGE_HEADER_RIGHT = 'RH'

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

Different header for Odd/Even, defaults to false.

Type

bool

$differentFirst

$differentFirst : bool

Different header for first page, defaults to false.

Type

bool

$scaleWithDocument

$scaleWithDocument : bool

Scale with document, defaults to true.

Type

bool

$alignWithMargins

$alignWithMargins : bool

Align with margins, defaults to true.

Type

bool

$headerFooterImages

$headerFooterImages : \PhpOffice\PhpSpreadsheet\Worksheet\HeaderFooterDrawing[]

Header/footer images.

Type

HeaderFooterDrawing[]

Methods

__construct()

__construct() : mixed

Create a new HeaderFooter.

Returns

mixed —

getOddHeader()

getOddHeader() : string

Get OddHeader.

Returns

string —

setOddHeader()

setOddHeader(string  $pValue) : $this

Set OddHeader.

Parameters

string $pValue

Returns

$this —

getOddFooter()

getOddFooter() : string

Get OddFooter.

Returns

string —

setOddFooter()

setOddFooter(string  $pValue) : $this

Set OddFooter.

Parameters

string $pValue

Returns

$this —

getEvenHeader()

getEvenHeader() : string

Get EvenHeader.

Returns

string —

setEvenHeader()

setEvenHeader(string  $pValue) : $this

Set EvenHeader.

Parameters

string $pValue

Returns

$this —

getEvenFooter()

getEvenFooter() : string

Get EvenFooter.

Returns

string —

setEvenFooter()

setEvenFooter(string  $pValue) : $this

Set EvenFooter.

Parameters

string $pValue

Returns

$this —

getFirstHeader()

getFirstHeader() : string

Get FirstHeader.

Returns

string —

setFirstHeader()

setFirstHeader(string  $pValue) : $this

Set FirstHeader.

Parameters

string $pValue

Returns

$this —

getFirstFooter()

getFirstFooter() : string

Get FirstFooter.

Returns

string —

setFirstFooter()

setFirstFooter(string  $pValue) : $this

Set FirstFooter.

Parameters

string $pValue

Returns

$this —

getDifferentOddEven()

getDifferentOddEven() : bool

Get DifferentOddEven.

Returns

bool —

setDifferentOddEven()

setDifferentOddEven(bool  $pValue) : $this

Set DifferentOddEven.

Parameters

bool $pValue

Returns

$this —

getDifferentFirst()

getDifferentFirst() : bool

Get DifferentFirst.

Returns

bool —

setDifferentFirst()

setDifferentFirst(bool  $pValue) : $this

Set DifferentFirst.

Parameters

bool $pValue

Returns

$this —

getScaleWithDocument()

getScaleWithDocument() : bool

Get ScaleWithDocument.

Returns

bool —

setScaleWithDocument()

setScaleWithDocument(bool  $pValue) : $this

Set ScaleWithDocument.

Parameters

bool $pValue

Returns

$this —

getAlignWithMargins()

getAlignWithMargins() : bool

Get AlignWithMargins.

Returns

bool —

setAlignWithMargins()

setAlignWithMargins(bool  $pValue) : $this

Set AlignWithMargins.

Parameters

bool $pValue

Returns

$this —

addImage()

addImage(\PhpOffice\PhpSpreadsheet\Worksheet\HeaderFooterDrawing  $image, string  $location = self::IMAGE_HEADER_LEFT) : $this

Add header/footer image.

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\HeaderFooterDrawing $image
string $location

Returns

$this —

removeImage()

removeImage(string  $location = self::IMAGE_HEADER_LEFT) : $this

Remove header/footer image.

Parameters

string $location

Returns

$this —

setImages()

setImages(\PhpOffice\PhpSpreadsheet\Worksheet\HeaderFooterDrawing[]  $images) : $this

Set header/footer images.

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\HeaderFooterDrawing[] $images

Returns

$this —

getImages()

getImages() : \PhpOffice\PhpSpreadsheet\Worksheet\HeaderFooterDrawing[]

Get header/footer images.

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\HeaderFooterDrawing[] —

__clone()

__clone() : mixed

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

Returns

mixed —