PHPExcel_Worksheet
[ class tree: PHPExcel_Worksheet ] [ index: PHPExcel_Worksheet ] [ all elements ]

Class: PHPExcel_Worksheet_HeaderFooter

Source Location: /PHPExcel/Worksheet/HeaderFooter.php

Class Overview


PHPExcel_Worksheet_HeaderFooter


Author(s):

Copyright:

  • Copyright (c) 2006 - 2009 PHPExcel (http://www.codeplex.com/PHPExcel)

Variables

Constants

Methods



Class Details

[line 108]
PHPExcel_Worksheet_HeaderFooter

PHPExcel_Worksheet_HeaderFooter

  1.  Header/Footer Formatting Syntax taken from Office Open XML Part Markup Language Referencepage 1970:
  2.  
  3.  There are a number of formatting codes that can be written inline with the actual header / footer textwhich
  4.  affect the formatting in the header or footer.
  5.  
  6.  ExampleThis example shows the text "Center Bold Header" on the first line (center section)and the date on
  7.  the second line (center section).
  8.          &CCenter &"-,Bold"Bold&"-,Regular"Header_x000A_&D
  9.  
  10.  General Rules:
  11.  There is no required order in which these codes must appear.
  12.  
  13.  The first occurrence of the following codes turns the formatting ONthe second occurrence turns it OFF again:
  14.  - strikethrough
  15.  - superscript
  16.  - subscript
  17.  Superscript and subscript cannot both be ON at same timeWhichever comes first wins and the other is ignored,
  18.  while the first is ON.
  19.  &code for "left section" (there are three header / footer locations"left""center"and "right")When
  20.  two or more occurrences of this section marker existthe contents from all markers are concatenatedin the
  21.  order of appearanceand placed into the left section.
  22.  &code for "current page #"
  23.  &code for "total pages"
  24.  &font size code for "text font size"where font size is a font size in points.
  25.  &code for "text font color"
  26.  RGB Color is specified as RRGGBB
  27.  Theme Color is specifed as TTSNN where TT is the theme color IdS is either "+" or "-" of the tint/shade
  28.  valueNN is the tint/shade value.
  29.  &code for "text strikethrough" on off
  30.  &code for "text super script" on off
  31.  &code for "text subscript" on off
  32.  &code for "center section"When two or more occurrences of this section marker existthe contents
  33.  from all markers are concatenatedin the order of appearanceand placed into the center section.
  34.  
  35.  &code for "date"
  36.  &code for "time"
  37.  &code for "picture as background"
  38.  &code for "text single underline"
  39.  &code for "double underline"
  40.  &code for "right section"When two or more occurrences of this section marker existthe contents
  41.  from all markers are concatenatedin the order of appearanceand placed into the right section.
  42.  &code for "this workbook's file path"
  43.  &code for "this workbook's file name"
  44.  &code for "sheet tab name"
  45.  &+ - code for add to page #.
  46.  &- - code for subtract from page #.
  47.  &"font name,font type" code for "text font name" and "text font type"where font name and font type
  48.  are strings specifying the name and type of the fontseparated by a commaWhen a hyphen appears in font
  49.  nameit means "none specified"Both of font name and font type can be localized values.
  50.  &"-,Bold" code for "bold font style"
  51.  &also means "bold font style".
  52.  &"-,Regular" code for "regular font style"
  53.  &"-,Italic" code for "italic font style"
  54.  &also means "italic font style"
  55.  &"-,Bold Italic" code for "bold italic font style"
  56.  &code for "outline style"
  57.  &code for "shadow style"




Tags:

copyright:  Copyright (c) 2006 - 2009 PHPExcel (http://www.codeplex.com/PHPExcel)


[ Top ]


Class Variables

$_alignWithMargins =

[line 186]

Align with margins, defaults to true

Align with margins, defaults to true




Tags:

access:  private

Type:   boolean


[ Top ]

$_differentFirst =

[line 172]

Different header for first page, defaults to false

Different header for first page, defaults to false




Tags:

access:  private

Type:   boolean


[ Top ]

$_differentOddEven =

[line 165]

Different header for Odd/Even, defaults to false

Different header for Odd/Even, defaults to false




Tags:

access:  private

Type:   boolean


[ Top ]

$_evenFooter =

[line 144]

EvenFooter

EvenFooter




Tags:

access:  private

Type:   string


[ Top ]

$_evenHeader =

[line 137]

EvenHeader

EvenHeader




Tags:

access:  private

Type:   string


[ Top ]

$_firstFooter =

[line 158]

FirstFooter

FirstFooter




Tags:

access:  private

Type:   string


[ Top ]

$_firstHeader =

[line 151]

FirstHeader

FirstHeader




Tags:

access:  private

Type:   string


[ Top ]

$_headerFooterImages = array()

[line 193]

Header/footer images

Header/footer images




Tags:

access:  private

Type:   PHPExcel_Worksheet_HeaderFooterDrawing[]


[ Top ]

$_oddFooter =

[line 130]

OddFooter

OddFooter




Tags:

access:  private

Type:   string


[ Top ]

$_oddHeader =

[line 123]

OddHeader

OddHeader




Tags:

access:  private

Type:   string


[ Top ]

$_scaleWithDocument =

[line 179]

Scale with document, defaults to true

Scale with document, defaults to true




Tags:

access:  private

Type:   boolean


[ Top ]



Class Methods


constructor __construct [line 198]

PHPExcel_Worksheet_HeaderFooter __construct( )

Create a new PHPExcel_Worksheet_HeaderFooter

Create a new PHPExcel_Worksheet_HeaderFooter




Tags:

access:  public


[ Top ]

method addImage [line 422]

PHPExcel_Worksheet_HeaderFooter addImage( [PHPExcel_Worksheet_HeaderFooterDrawing $image = null], [string $location = self::IMAGE_HEADER_LEFT])

Add header/footer image

Add header/footer image




Tags:

throws:  Exception
access:  public


Parameters:

PHPExcel_Worksheet_HeaderFooterDrawing   $image  
string   $location  

[ Top ]

method getAlignWithMargins [line 399]

boolean getAlignWithMargins( )

Get AlignWithMargins

Get AlignWithMargins




Tags:

access:  public


[ Top ]

method getDifferentFirst [line 359]

boolean getDifferentFirst( )

Get DifferentFirst

Get DifferentFirst




Tags:

access:  public


[ Top ]

method getDifferentOddEven [line 339]

boolean getDifferentOddEven( )

Get DifferentOddEven

Get DifferentOddEven




Tags:

access:  public


[ Top ]

method getEvenFooter [line 279]

string getEvenFooter( )

Get EvenFooter

Get EvenFooter




Tags:

access:  public


[ Top ]

method getEvenHeader [line 259]

string getEvenHeader( )

Get EvenHeader

Get EvenHeader




Tags:

access:  public


[ Top ]

method getFirstFooter [line 319]

string getFirstFooter( )

Get FirstFooter

Get FirstFooter




Tags:

access:  public


[ Top ]

method getFirstHeader [line 299]

string getFirstHeader( )

Get FirstHeader

Get FirstHeader




Tags:

access:  public


[ Top ]

method getImages [line 462]

HPExcel_Worksheet_HeaderFooterDrawing[] getImages( )

Get header/footer images

Get header/footer images




Tags:

access:  public


[ Top ]

method getOddFooter [line 239]

string getOddFooter( )

Get OddFooter

Get OddFooter




Tags:

access:  public


[ Top ]

method getOddHeader [line 219]

string getOddHeader( )

Get OddHeader

Get OddHeader




Tags:

access:  public


[ Top ]

method getScaleWithDocument [line 379]

boolean getScaleWithDocument( )

Get ScaleWithDocument

Get ScaleWithDocument




Tags:

access:  public


[ Top ]

method removeImage [line 434]

PHPExcel_Worksheet_HeaderFooter removeImage( [string $location = self::IMAGE_HEADER_LEFT])

Remove header/footer image

Remove header/footer image




Tags:

throws:  Exception
access:  public


Parameters:

string   $location  

[ Top ]

method setAlignWithMargins [line 409]

PHPExcel_Worksheet_HeaderFooter setAlignWithMargins( [boolean $pValue = true])

Set AlignWithMargins

Set AlignWithMargins




Tags:

access:  public


Parameters:

boolean   $pValue  

[ Top ]

method setDifferentFirst [line 369]

PHPExcel_Worksheet_HeaderFooter setDifferentFirst( [boolean $pValue = false])

Set DifferentFirst

Set DifferentFirst




Tags:

access:  public


Parameters:

boolean   $pValue  

[ Top ]

method setDifferentOddEven [line 349]

PHPExcel_Worksheet_HeaderFooter setDifferentOddEven( [boolean $pValue = false])

Set DifferentOddEven

Set DifferentOddEven




Tags:

access:  public


Parameters:

boolean   $pValue  

[ Top ]

method setEvenFooter [line 289]

PHPExcel_Worksheet_HeaderFooter setEvenFooter( string $pValue)

Set EvenFooter

Set EvenFooter




Tags:

access:  public


Parameters:

string   $pValue  

[ Top ]

method setEvenHeader [line 269]

PHPExcel_Worksheet_HeaderFooter setEvenHeader( string $pValue)

Set EvenHeader

Set EvenHeader




Tags:

access:  public


Parameters:

string   $pValue  

[ Top ]

method setFirstFooter [line 329]

PHPExcel_Worksheet_HeaderFooter setFirstFooter( string $pValue)

Set FirstFooter

Set FirstFooter




Tags:

access:  public


Parameters:

string   $pValue  

[ Top ]

method setFirstHeader [line 309]

PHPExcel_Worksheet_HeaderFooter setFirstHeader( string $pValue)

Set FirstHeader

Set FirstHeader




Tags:

access:  public


Parameters:

string   $pValue  

[ Top ]

method setImages [line 448]

PHPExcel_Worksheet_HeaderFooter setImages( PHPExcel_Worksheet_HeaderFooterDrawing[] $images)

Set header/footer images

Set header/footer images




Tags:

throws:  Exception
access:  public


Parameters:

PHPExcel_Worksheet_HeaderFooterDrawing[]   $images  

[ Top ]

method setOddFooter [line 249]

PHPExcel_Worksheet_HeaderFooter setOddFooter( string $pValue)

Set OddFooter

Set OddFooter




Tags:

access:  public


Parameters:

string   $pValue  

[ Top ]

method setOddHeader [line 229]

PHPExcel_Worksheet_HeaderFooter setOddHeader( string $pValue)

Set OddHeader

Set OddHeader




Tags:

access:  public


Parameters:

string   $pValue  

[ Top ]

method setScaleWithDocument [line 389]

PHPExcel_Worksheet_HeaderFooter setScaleWithDocument( [boolean $pValue = true])

Set ScaleWithDocument

Set ScaleWithDocument




Tags:

access:  public


Parameters:

boolean   $pValue  

[ Top ]

method __clone [line 479]

void __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.




Tags:

access:  public


[ Top ]


Class Constants

IMAGE_FOOTER_CENTER =  'CF'

[line 115]


[ Top ]

IMAGE_FOOTER_LEFT =  'LF'

[line 114]


[ Top ]

IMAGE_FOOTER_RIGHT =  'RF'

[line 116]


[ Top ]

IMAGE_HEADER_CENTER =  'CH'

[line 112]


[ Top ]

IMAGE_HEADER_LEFT =  'LH'

[line 111]


[ Top ]

IMAGE_HEADER_RIGHT =  'RH'

[line 113]


[ Top ]



Documentation generated on Mon, 10 Aug 2009 08:05:50 +0200 by phpDocumentor 1.4.1