class HeaderFooter (View source)

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"

Constants

IMAGE_HEADER_LEFT

IMAGE_HEADER_CENTER

IMAGE_HEADER_RIGHT

IMAGE_FOOTER_LEFT

IMAGE_FOOTER_CENTER

IMAGE_FOOTER_RIGHT

Methods

__construct()

Create a new HeaderFooter.

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.

bool
getDifferentOddEven()

Get DifferentOddEven.

setDifferentOddEven(bool $pValue)

Set DifferentOddEven.

bool
getDifferentFirst()

Get DifferentFirst.

setDifferentFirst(bool $pValue)

Set DifferentFirst.

bool
getScaleWithDocument()

Get ScaleWithDocument.

setScaleWithDocument(bool $pValue)

Set ScaleWithDocument.

bool
getAlignWithMargins()

Get AlignWithMargins.

setAlignWithMargins(bool $pValue)

Set AlignWithMargins.

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

Add header/footer image.

removeImage(string $location = self::IMAGE_HEADER_LEFT)

Remove header/footer image.

setImages(array $images)

Set header/footer images.

getImages()

Get header/footer images.

__clone()

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

Details

__construct()

Create a new HeaderFooter.

string getOddHeader()

Get OddHeader.

Return Value

string

HeaderFooter setOddHeader(string $pValue)

Set OddHeader.

Parameters

string $pValue

Return Value

HeaderFooter

string getOddFooter()

Get OddFooter.

Return Value

string

HeaderFooter setOddFooter(string $pValue)

Set OddFooter.

Parameters

string $pValue

Return Value

HeaderFooter

string getEvenHeader()

Get EvenHeader.

Return Value

string

HeaderFooter setEvenHeader(string $pValue)

Set EvenHeader.

Parameters

string $pValue

Return Value

HeaderFooter

string getEvenFooter()

Get EvenFooter.

Return Value

string

HeaderFooter setEvenFooter(string $pValue)

Set EvenFooter.

Parameters

string $pValue

Return Value

HeaderFooter

string getFirstHeader()

Get FirstHeader.

Return Value

string

HeaderFooter setFirstHeader(string $pValue)

Set FirstHeader.

Parameters

string $pValue

Return Value

HeaderFooter

string getFirstFooter()

Get FirstFooter.

Return Value

string

HeaderFooter setFirstFooter(string $pValue)

Set FirstFooter.

Parameters

string $pValue

Return Value

HeaderFooter

bool getDifferentOddEven()

Get DifferentOddEven.

Return Value

bool

HeaderFooter setDifferentOddEven(bool $pValue)

Set DifferentOddEven.

Parameters

bool $pValue

Return Value

HeaderFooter

bool getDifferentFirst()

Get DifferentFirst.

Return Value

bool

HeaderFooter setDifferentFirst(bool $pValue)

Set DifferentFirst.

Parameters

bool $pValue

Return Value

HeaderFooter

bool getScaleWithDocument()

Get ScaleWithDocument.

Return Value

bool

HeaderFooter setScaleWithDocument(bool $pValue)

Set ScaleWithDocument.

Parameters

bool $pValue

Return Value

HeaderFooter

bool getAlignWithMargins()

Get AlignWithMargins.

Return Value

bool

HeaderFooter setAlignWithMargins(bool $pValue)

Set AlignWithMargins.

Parameters

bool $pValue

Return Value

HeaderFooter

HeaderFooter addImage(HeaderFooterDrawing $image, string $location = self::IMAGE_HEADER_LEFT)

Add header/footer image.

Parameters

HeaderFooterDrawing $image
string $location

Return Value

HeaderFooter

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

Remove header/footer image.

Parameters

string $location

Return Value

HeaderFooter

HeaderFooter setImages(array $images)

Set header/footer images.

Parameters

array $images

Return Value

HeaderFooter

HeaderFooterDrawing[] getImages()

Get header/footer images.

Return Value

HeaderFooterDrawing[]

__clone()

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