PHPXRef 0.7.1 : moodle-2.8 : Detail view of HeaderFooter.php

Class: PHPExcel_Worksheet_HeaderFooter - X-Ref

PHPExcel_Worksheet_HeaderFooter

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

__construct() X-Ref

Create a new PHPExcel_Worksheet_HeaderFooter

getOddHeader() X-Ref

Get OddHeader

return: string

setOddHeader($pValue) X-Ref

Set OddHeader

param: string $pValue
return: PHPExcel_Worksheet_HeaderFooter

getOddFooter() X-Ref

Get OddFooter

return: string

setOddFooter($pValue) X-Ref

Set OddFooter

param: string $pValue
return: PHPExcel_Worksheet_HeaderFooter

getEvenHeader() X-Ref

Get EvenHeader

return: string

setEvenHeader($pValue) X-Ref

Set EvenHeader

param: string $pValue
return: PHPExcel_Worksheet_HeaderFooter

getEvenFooter() X-Ref

Get EvenFooter

return: string

setEvenFooter($pValue) X-Ref

Set EvenFooter

param: string $pValue
return: PHPExcel_Worksheet_HeaderFooter

getFirstHeader() X-Ref

Get FirstHeader

return: string

setFirstHeader($pValue) X-Ref

Set FirstHeader

param: string $pValue
return: PHPExcel_Worksheet_HeaderFooter

getFirstFooter() X-Ref

Get FirstFooter

return: string

setFirstFooter($pValue) X-Ref

Set FirstFooter

param: string $pValue
return: PHPExcel_Worksheet_HeaderFooter

getDifferentOddEven() X-Ref

Get DifferentOddEven

return: boolean

setDifferentOddEven($pValue = false) X-Ref

Set DifferentOddEven

param: boolean $pValue
return: PHPExcel_Worksheet_HeaderFooter

getDifferentFirst() X-Ref

Get DifferentFirst

return: boolean

setDifferentFirst($pValue = false) X-Ref

Set DifferentFirst

param: boolean $pValue
return: PHPExcel_Worksheet_HeaderFooter

getScaleWithDocument() X-Ref

Get ScaleWithDocument

return: boolean

setScaleWithDocument($pValue = true) X-Ref

Set ScaleWithDocument

param: boolean $pValue
return: PHPExcel_Worksheet_HeaderFooter

getAlignWithMargins() X-Ref

Get AlignWithMargins

return: boolean

setAlignWithMargins($pValue = true) X-Ref

Set AlignWithMargins

param: boolean $pValue
return: PHPExcel_Worksheet_HeaderFooter

addImage(PHPExcel_Worksheet_HeaderFooterDrawing $image = null, $location = self::IMAGE_HEADER_LEFT) X-Ref

Add header/footer image

param: PHPExcel_Worksheet_HeaderFooterDrawing $image
param: string $location
return: PHPExcel_Worksheet_HeaderFooter

removeImage($location = self::IMAGE_HEADER_LEFT) X-Ref

Remove header/footer image

param: string $location
return: PHPExcel_Worksheet_HeaderFooter

setImages($images) X-Ref

Set header/footer images

param: PHPExcel_Worksheet_HeaderFooterDrawing[] $images
return: PHPExcel_Worksheet_HeaderFooter

getImages() X-Ref

Get header/footer images

return: PHPExcel_Worksheet_HeaderFooterDrawing[]

__clone() X-Ref

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

Copyright:	Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
License:	http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
Version:	##VERSION##, ##DATE##
File Size:	465 lines (12 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of moodle-2.8

/lib/phpexcel/PHPExcel/Worksheet/ -> HeaderFooter.php (summary)

Defines 1 class