Documentation

HeaderFooter
in package

<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"

Table of Contents

Constants

IMAGE_FOOTER_CENTER  = 'CF'
IMAGE_FOOTER_LEFT  = 'LF'
IMAGE_FOOTER_RIGHT  = 'RF'
IMAGE_HEADER_CENTER  = 'CH'
IMAGE_HEADER_LEFT  = 'LH'
IMAGE_HEADER_RIGHT  = 'RH'

Properties

$alignWithMargins  : bool
Align with margins, defaults to true.
$differentFirst  : bool
Different header for first page, defaults to false.
$differentOddEven  : bool
Different header for Odd/Even, defaults to false.
$evenFooter  : string
EvenFooter.
$evenHeader  : string
EvenHeader.
$firstFooter  : string
FirstFooter.
$firstHeader  : string
FirstHeader.
$headerFooterImages  : array<string|int, HeaderFooterDrawing>
Header/footer images.
$oddFooter  : string
OddFooter.
$oddHeader  : string
OddHeader.
$scaleWithDocument  : bool
Scale with document, defaults to true.

Methods

__clone()  : mixed
Implement PHP __clone to create a deep clone, not just a shallow copy.
__construct()  : mixed
Create a new HeaderFooter.
addImage()  : $this
Add header/footer image.
getAlignWithMargins()  : bool
Get AlignWithMargins.
getDifferentFirst()  : bool
Get DifferentFirst.
getDifferentOddEven()  : bool
Get DifferentOddEven.
getEvenFooter()  : string
Get EvenFooter.
getEvenHeader()  : string
Get EvenHeader.
getFirstFooter()  : string
Get FirstFooter.
getFirstHeader()  : string
Get FirstHeader.
getImages()  : array<string|int, HeaderFooterDrawing>
Get header/footer images.
getOddFooter()  : string
Get OddFooter.
getOddHeader()  : string
Get OddHeader.
getScaleWithDocument()  : bool
Get ScaleWithDocument.
removeImage()  : $this
Remove header/footer image.
setAlignWithMargins()  : $this
Set AlignWithMargins.
setDifferentFirst()  : $this
Set DifferentFirst.
setDifferentOddEven()  : $this
Set DifferentOddEven.
setEvenFooter()  : $this
Set EvenFooter.
setEvenHeader()  : $this
Set EvenHeader.
setFirstFooter()  : $this
Set FirstFooter.
setFirstHeader()  : $this
Set FirstHeader.
setImages()  : $this
Set header/footer images.
setOddFooter()  : $this
Set OddFooter.
setOddHeader()  : $this
Set OddHeader.
setScaleWithDocument()  : $this
Set ScaleWithDocument.

Constants

IMAGE_FOOTER_CENTER

public mixed IMAGE_FOOTER_CENTER = 'CF'

IMAGE_FOOTER_RIGHT

public mixed IMAGE_FOOTER_RIGHT = 'RF'

IMAGE_HEADER_CENTER

public mixed IMAGE_HEADER_CENTER = 'CH'

IMAGE_HEADER_RIGHT

public mixed IMAGE_HEADER_RIGHT = 'RH'

Properties

$alignWithMargins

Align with margins, defaults to true.

private bool $alignWithMargins = true

$differentFirst

Different header for first page, defaults to false.

private bool $differentFirst = false

$differentOddEven

Different header for Odd/Even, defaults to false.

private bool $differentOddEven = false

$firstFooter

FirstFooter.

private string $firstFooter = ''

$firstHeader

FirstHeader.

private string $firstHeader = ''

$scaleWithDocument

Scale with document, defaults to true.

private bool $scaleWithDocument = true

Methods

__clone()

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

public __clone() : mixed

__construct()

Create a new HeaderFooter.

public __construct() : mixed

getAlignWithMargins()

Get AlignWithMargins.

public getAlignWithMargins() : bool
Return values
bool

getDifferentFirst()

Get DifferentFirst.

public getDifferentFirst() : bool
Return values
bool

getDifferentOddEven()

Get DifferentOddEven.

public getDifferentOddEven() : bool
Return values
bool

getEvenFooter()

Get EvenFooter.

public getEvenFooter() : string
Return values
string

getEvenHeader()

Get EvenHeader.

public getEvenHeader() : string
Return values
string

getFirstFooter()

Get FirstFooter.

public getFirstFooter() : string
Return values
string

getFirstHeader()

Get FirstHeader.

public getFirstHeader() : string
Return values
string

getOddFooter()

Get OddFooter.

public getOddFooter() : string
Return values
string

getOddHeader()

Get OddHeader.

public getOddHeader() : string
Return values
string

getScaleWithDocument()

Get ScaleWithDocument.

public getScaleWithDocument() : bool
Return values
bool

removeImage()

Remove header/footer image.

public removeImage([string $location = self::IMAGE_HEADER_LEFT ]) : $this
Parameters
$location : string = self::IMAGE_HEADER_LEFT
Return values
$this

setAlignWithMargins()

Set AlignWithMargins.

public setAlignWithMargins(bool $alignWithMargins) : $this
Parameters
$alignWithMargins : bool
Return values
$this

setDifferentFirst()

Set DifferentFirst.

public setDifferentFirst(bool $differentFirst) : $this
Parameters
$differentFirst : bool
Return values
$this

setDifferentOddEven()

Set DifferentOddEven.

public setDifferentOddEven(bool $differentOddEvent) : $this
Parameters
$differentOddEvent : bool
Return values
$this

setEvenFooter()

Set EvenFooter.

public setEvenFooter(string $evenFooter) : $this
Parameters
$evenFooter : string
Return values
$this

setEvenHeader()

Set EvenHeader.

public setEvenHeader(string $eventHeader) : $this
Parameters
$eventHeader : string
Return values
$this

setFirstFooter()

Set FirstFooter.

public setFirstFooter(string $firstFooter) : $this
Parameters
$firstFooter : string
Return values
$this

setFirstHeader()

Set FirstHeader.

public setFirstHeader(string $firstHeader) : $this
Parameters
$firstHeader : string
Return values
$this

setOddFooter()

Set OddFooter.

public setOddFooter(string $oddFooter) : $this
Parameters
$oddFooter : string
Return values
$this

setOddHeader()

Set OddHeader.

public setOddHeader(string $oddHeader) : $this
Parameters
$oddHeader : string
Return values
$this

setScaleWithDocument()

Set ScaleWithDocument.

public setScaleWithDocument(bool $scaleWithDocument) : $this
Parameters
$scaleWithDocument : bool
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results