Overview

Packages

  • JAMA
  • None
  • PHP
  • PHPExcel
    • CachedObjectStorage
    • Calculation
    • Cell
    • Chart
      • Renderer
    • Reader
      • Excel2007
      • Excel5
    • RichText
    • Settings
    • Shared
      • Escher
      • OLE
      • Trend
      • ZipArchive
    • Style
    • Worksheet
      • Drawing
    • Writer
      • 2007
      • CSV
      • Excel2007
      • Excel5
      • HTML
      • PDF

Classes

  • PHPExcel_Worksheet
  • PHPExcel_Worksheet_AutoFilter
  • PHPExcel_Worksheet_AutoFilter_Column
  • PHPExcel_Worksheet_AutoFilter_Column_Rule
  • PHPExcel_Worksheet_BaseDrawing
  • PHPExcel_Worksheet_CellIterator
  • PHPExcel_Worksheet_ColumnDimension
  • PHPExcel_Worksheet_HeaderFooter
  • PHPExcel_Worksheet_HeaderFooterDrawing
  • PHPExcel_Worksheet_MemoryDrawing
  • PHPExcel_Worksheet_PageMargins
  • PHPExcel_Worksheet_PageSetup
  • PHPExcel_Worksheet_Protection
  • PHPExcel_Worksheet_Row
  • PHPExcel_Worksheet_RowDimension
  • PHPExcel_Worksheet_RowIterator
  • PHPExcel_Worksheet_SheetView
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Class 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"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"
Package: PHPExcel\Worksheet
Category: PHPExcel
Copyright: Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
License: LGPL
Located at controlador/include/phpexcel/PHPExcel/Worksheet/HeaderFooter.php
Methods summary
public
# __construct( )

Create a new PHPExcel_Worksheet_HeaderFooter

Create a new PHPExcel_Worksheet_HeaderFooter

public string
# getOddHeader( )

Get OddHeader

Get OddHeader

Returns

string
public PHPExcel_Worksheet_HeaderFooter
# setOddHeader( string $pValue )

Set OddHeader

Set OddHeader

Parameters

$pValue

Returns

PHPExcel_Worksheet_HeaderFooter
public string
# getOddFooter( )

Get OddFooter

Get OddFooter

Returns

string
public PHPExcel_Worksheet_HeaderFooter
# setOddFooter( string $pValue )

Set OddFooter

Set OddFooter

Parameters

$pValue

Returns

PHPExcel_Worksheet_HeaderFooter
public string
# getEvenHeader( )

Get EvenHeader

Get EvenHeader

Returns

string
public PHPExcel_Worksheet_HeaderFooter
# setEvenHeader( string $pValue )

Set EvenHeader

Set EvenHeader

Parameters

$pValue

Returns

PHPExcel_Worksheet_HeaderFooter
public string
# getEvenFooter( )

Get EvenFooter

Get EvenFooter

Returns

string
public PHPExcel_Worksheet_HeaderFooter
# setEvenFooter( string $pValue )

Set EvenFooter

Set EvenFooter

Parameters

$pValue

Returns

PHPExcel_Worksheet_HeaderFooter
public string
# getFirstHeader( )

Get FirstHeader

Get FirstHeader

Returns

string
public PHPExcel_Worksheet_HeaderFooter
# setFirstHeader( string $pValue )

Set FirstHeader

Set FirstHeader

Parameters

$pValue

Returns

PHPExcel_Worksheet_HeaderFooter
public string
# getFirstFooter( )

Get FirstFooter

Get FirstFooter

Returns

string
public PHPExcel_Worksheet_HeaderFooter
# setFirstFooter( string $pValue )

Set FirstFooter

Set FirstFooter

Parameters

$pValue

Returns

PHPExcel_Worksheet_HeaderFooter
public boolean
# getDifferentOddEven( )

Get DifferentOddEven

Get DifferentOddEven

Returns

boolean
public PHPExcel_Worksheet_HeaderFooter
# setDifferentOddEven( boolean $pValue = false )

Set DifferentOddEven

Set DifferentOddEven

Parameters

$pValue

Returns

PHPExcel_Worksheet_HeaderFooter
public boolean
# getDifferentFirst( )

Get DifferentFirst

Get DifferentFirst

Returns

boolean
public PHPExcel_Worksheet_HeaderFooter
# setDifferentFirst( boolean $pValue = false )

Set DifferentFirst

Set DifferentFirst

Parameters

$pValue

Returns

PHPExcel_Worksheet_HeaderFooter
public boolean
# getScaleWithDocument( )

Get ScaleWithDocument

Get ScaleWithDocument

Returns

boolean
public PHPExcel_Worksheet_HeaderFooter
# setScaleWithDocument( boolean $pValue = true )

Set ScaleWithDocument

Set ScaleWithDocument

Parameters

$pValue

Returns

PHPExcel_Worksheet_HeaderFooter
public boolean
# getAlignWithMargins( )

Get AlignWithMargins

Get AlignWithMargins

Returns

boolean
public PHPExcel_Worksheet_HeaderFooter
# setAlignWithMargins( boolean $pValue = true )

Set AlignWithMargins

Set AlignWithMargins

Parameters

$pValue

Returns

PHPExcel_Worksheet_HeaderFooter
public PHPExcel_Worksheet_HeaderFooter
# addImage( PHPExcel_Worksheet_HeaderFooterDrawing $image = null, string $location = PHPExcel_Worksheet_HeaderFooter::IMAGE_HEADER_LEFT )

Add header/footer image

Add header/footer image

Parameters

$image
$location

Returns

PHPExcel_Worksheet_HeaderFooter

Throws

PHPExcel_Exception
public PHPExcel_Worksheet_HeaderFooter
# removeImage( string $location = PHPExcel_Worksheet_HeaderFooter::IMAGE_HEADER_LEFT )

Remove header/footer image

Remove header/footer image

Parameters

$location

Returns

PHPExcel_Worksheet_HeaderFooter

Throws

PHPExcel_Exception
public PHPExcel_Worksheet_HeaderFooter
# setImages( PHPExcel_Worksheet_HeaderFooterDrawing[] $images )

Set header/footer images

Set header/footer images

Parameters

$images

Returns

PHPExcel_Worksheet_HeaderFooter

Throws

PHPExcel_Exception
public PHPExcel_Worksheet_HeaderFooterDrawing[]
# getImages( )

Get header/footer images

Get header/footer images

Returns

PHPExcel_Worksheet_HeaderFooterDrawing[]
public
# __clone( )

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

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

Constants summary
string IMAGE_HEADER_LEFT
# 'LH'
string IMAGE_HEADER_CENTER
# 'CH'
string IMAGE_HEADER_RIGHT
# 'RH'
string IMAGE_FOOTER_LEFT
# 'LF'
string IMAGE_FOOTER_CENTER
# 'CF'
string IMAGE_FOOTER_RIGHT
# 'RF'
Properties summary
private string $_oddHeader

OddHeader

OddHeader

# ''
private string $_oddFooter

OddFooter

OddFooter

# ''
private string $_evenHeader

EvenHeader

EvenHeader

# ''
private string $_evenFooter

EvenFooter

EvenFooter

# ''
private string $_firstHeader

FirstHeader

FirstHeader

# ''
private string $_firstFooter

FirstFooter

FirstFooter

# ''
private boolean $_differentOddEven

Different header for Odd/Even, defaults to false

Different header for Odd/Even, defaults to false

# false
private boolean $_differentFirst

Different header for first page, defaults to false

Different header for first page, defaults to false

# false
private boolean $_scaleWithDocument

Scale with document, defaults to true

Scale with document, defaults to true

# true
private boolean $_alignWithMargins

Align with margins, defaults to true

Align with margins, defaults to true

# true
private PHPExcel_Worksheet_HeaderFooterDrawing[] $_headerFooterImages

Header/footer images

Header/footer images

# array()
Autene API documentation generated by ApiGen