\PHPExcel_Writer_Excel5_Xf

PHPExcel_Writer_Excel5_Xf

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Summary

Methods
Properties
Constants
__construct()
writeXf()
setIsStyleXf()
setBottomColor()
setTopColor()
setLeftColor()
setRightColor()
setDiagColor()
setFgColor()
setBgColor()
setNumberFormatIndex()
setFontIndex()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
mapBorderStyle()
mapFillType()
mapHAlign()
mapVAlign()
mapTextRotation()
mapLocked()
mapHidden()
$isStyleXf
$fontIndex
$numberFormatIndex
$textJustLast
$foregroundColor
$backgroundColor
$bottomBorderColor
$topBorderColor
$leftBorderColor
$rightBorderColor
$mapBorderStyles
$mapFillTypes
$mapHAlignments
$mapVAlignments
N/A

Properties

$isStyleXf

$isStyleXf : boolean

Style XF or a cell XF ?

Type

boolean

$fontIndex

$fontIndex : integer

Index to the FONT record. Index 4 does not exist

Type

integer

$numberFormatIndex

$numberFormatIndex : integer

An index (2 bytes) to a FORMAT record (number format).

Type

integer

$textJustLast

$textJustLast : integer

1 bit, apparently not used.

Type

integer

$foregroundColor

$foregroundColor : integer

The cell's foreground color.

Type

integer

$backgroundColor

$backgroundColor : integer

The cell's background color.

Type

integer

$bottomBorderColor

$bottomBorderColor : integer

Color of the bottom border of the cell.

Type

integer

$topBorderColor

$topBorderColor : integer

Color of the top border of the cell.

Type

integer

$leftBorderColor

$leftBorderColor : integer

Color of the left border of the cell.

Type

integer

$rightBorderColor

$rightBorderColor : integer

Color of the right border of the cell.

Type

integer

$mapBorderStyles

$mapBorderStyles : 

Map of BIFF2-BIFF8 codes for border styles

Type

$mapFillTypes

$mapFillTypes : 

Map of BIFF2-BIFF8 codes for fill types

Type

$mapHAlignments

$mapHAlignments : 

Map of BIFF2-BIFF8 codes for horizontal alignment

Type

$mapVAlignments

$mapVAlignments : 

Map of BIFF2-BIFF8 codes for vertical alignment

Type

Methods

__construct()

__construct(\PHPExcel_Style  $style = null) 

Constructor

Parameters

\PHPExcel_Style $style

writeXf()

writeXf() : string

Generate an Excel BIFF XF record (style or cell).

Returns

string —

The XF record

setIsStyleXf()

setIsStyleXf(boolean  $value) 

Is this a style XF ?

Parameters

boolean $value

setBottomColor()

setBottomColor(integer  $colorIndex) 

Sets the cell's bottom border color

Parameters

integer $colorIndex

Color index

setTopColor()

setTopColor(integer  $colorIndex) 

Sets the cell's top border color

Parameters

integer $colorIndex

Color index

setLeftColor()

setLeftColor(integer  $colorIndex) 

Sets the cell's left border color

Parameters

integer $colorIndex

Color index

setRightColor()

setRightColor(integer  $colorIndex) 

Sets the cell's right border color

Parameters

integer $colorIndex

Color index

setDiagColor()

setDiagColor(integer  $colorIndex) 

Sets the cell's diagonal border color

Parameters

integer $colorIndex

Color index

setFgColor()

setFgColor(integer  $colorIndex) 

Sets the cell's foreground color

Parameters

integer $colorIndex

Color index

setBgColor()

setBgColor(integer  $colorIndex) 

Sets the cell's background color

Parameters

integer $colorIndex

Color index

setNumberFormatIndex()

setNumberFormatIndex(integer  $numberFormatIndex) 

Sets the index to the number format record It can be date, time, currency, etc.

..

Parameters

integer $numberFormatIndex

Index to format record

setFontIndex()

setFontIndex(integer  $value) 

Set the font index.

Parameters

integer $value

Font index, note that value 4 does not exist

mapBorderStyle()

mapBorderStyle(string  $borderStyle) : integer

Map border style

Parameters

string $borderStyle

Returns

integer

mapFillType()

mapFillType(string  $fillType) : integer

Map fill type

Parameters

string $fillType

Returns

integer

mapHAlign()

mapHAlign(string  $hAlign) : integer

Map to BIFF2-BIFF8 codes for horizontal alignment

Parameters

string $hAlign

Returns

integer

mapVAlign()

mapVAlign(string  $vAlign) : integer

Map to BIFF2-BIFF8 codes for vertical alignment

Parameters

string $vAlign

Returns

integer

mapTextRotation()

mapTextRotation(integer  $textRotation) : integer

Map to BIFF8 codes for text rotation angle

Parameters

integer $textRotation

Returns

integer

mapLocked()

mapLocked(  $locked) : integer

Map locked

Parameters

$locked

Returns

integer

mapHidden()

mapHidden(  $hidden) : integer

Map hidden

Parameters

$hidden

Returns

integer