\PHPExcel_Style_Font

PHPExcel_Style_Font

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()
bindParent()
getIsSupervisor()
getActiveSheet()
getSelectedCells()
getActiveCell()
__clone()
getSharedComponent()
getStyleArray()
applyFromArray()
getName()
setName()
getSize()
setSize()
getBold()
setBold()
getItalic()
setItalic()
getSuperScript()
setSuperScript()
getSubScript()
setSubScript()
getUnderline()
setUnderline()
getStrikethrough()
setStrikethrough()
getColor()
setColor()
getHashCode()
No public properties found
UNDERLINE_NONE
UNDERLINE_DOUBLE
UNDERLINE_DOUBLEACCOUNTING
UNDERLINE_SINGLE
UNDERLINE_SINGLEACCOUNTING
No protected methods found
$isSupervisor
$parent
$name
$size
$bold
$italic
$superScript
$subScript
$underline
$strikethrough
$color
N/A
No private methods found
No private properties found
N/A

Constants

UNDERLINE_NONE

UNDERLINE_NONE = 'none'

UNDERLINE_DOUBLE

UNDERLINE_DOUBLE = 'double'

UNDERLINE_DOUBLEACCOUNTING

UNDERLINE_DOUBLEACCOUNTING = 'doubleAccounting'

UNDERLINE_SINGLE

UNDERLINE_SINGLE = 'single'

UNDERLINE_SINGLEACCOUNTING

UNDERLINE_SINGLEACCOUNTING = 'singleAccounting'

Properties

$isSupervisor

$isSupervisor : boolean

Supervisor?

Type

boolean

$parent

$parent : \PHPExcel_Style

Parent. Only used for supervisor

Type

\PHPExcel_Style

$name

$name : string

Font Name

Type

string

$size

$size : float

Font Size

Type

float

$bold

$bold : boolean

Bold

Type

boolean

$italic

$italic : boolean

Italic

Type

boolean

$superScript

$superScript : boolean

Superscript

Type

boolean

$subScript

$subScript : boolean

Subscript

Type

boolean

$underline

$underline : string

Underline

Type

string

$strikethrough

$strikethrough : boolean

Strikethrough

Type

boolean

Methods

__construct()

__construct(boolean  $isSupervisor = false, boolean  $isConditional = false) 

Create a new PHPExcel_Style_Font

Parameters

boolean $isSupervisor

Flag indicating if this is a supervisor or not Leave this value at default unless you understand exactly what its ramifications are

boolean $isConditional

Flag indicating if this is a conditional style or not Leave this value at default unless you understand exactly what its ramifications are

bindParent()

bindParent(\PHPExcel  $parent,   $parentPropertyName = null) : \PHPExcel_Style_Supervisor

Bind parent. Only used for supervisor

Parameters

\PHPExcel $parent
$parentPropertyName

Returns

\PHPExcel_Style_Supervisor

getIsSupervisor()

getIsSupervisor() : boolean

Is this a supervisor or a cell style component?

Returns

boolean

getActiveSheet()

getActiveSheet() : \PHPExcel_Worksheet

Get the currently active sheet. Only used for supervisor

Returns

\PHPExcel_Worksheet

getSelectedCells()

getSelectedCells() : string

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor

Returns

string —

E.g. 'A1'

getActiveCell()

getActiveCell() : string

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor

Returns

string —

E.g. 'A1'

__clone()

__clone() 

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

getSharedComponent()

getSharedComponent() : \PHPExcel_Style_Font

Get the shared style component for the currently active cell in currently active sheet.

Only used for style supervisor

Returns

\PHPExcel_Style_Font

getStyleArray()

getStyleArray(array  $array) : array

Build style array from subcomponents

Parameters

array $array

Returns

array

applyFromArray()

applyFromArray(array  $pStyles = null) : \PHPExcel_Style_Font

Apply styles from array

$objPHPExcel->getActiveSheet()->getStyle('B2')->getFont()->applyFromArray( array( 'name' => 'Arial', 'bold' => TRUE, 'italic' => FALSE, 'underline' => PHPExcel_Style_Font::UNDERLINE_DOUBLE, 'strike' => FALSE, 'color' => array( 'rgb' => '808080' ) ) );

Parameters

array $pStyles

Array containing style information

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Style_Font

getName()

getName() : string

Get Name

Returns

string

setName()

setName(string  $pValue = 'Calibri') : \PHPExcel_Style_Font

Set Name

Parameters

string $pValue

Returns

\PHPExcel_Style_Font

getSize()

getSize() : double

Get Size

Returns

double

setSize()

setSize(double  $pValue = 10) : \PHPExcel_Style_Font

Set Size

Parameters

double $pValue

Returns

\PHPExcel_Style_Font

getBold()

getBold() : boolean

Get Bold

Returns

boolean

setBold()

setBold(boolean  $pValue = false) : \PHPExcel_Style_Font

Set Bold

Parameters

boolean $pValue

Returns

\PHPExcel_Style_Font

getItalic()

getItalic() : boolean

Get Italic

Returns

boolean

setItalic()

setItalic(boolean  $pValue = false) : \PHPExcel_Style_Font

Set Italic

Parameters

boolean $pValue

Returns

\PHPExcel_Style_Font

getSuperScript()

getSuperScript() : boolean

Get SuperScript

Returns

boolean

setSuperScript()

setSuperScript(boolean  $pValue = false) : \PHPExcel_Style_Font

Set SuperScript

Parameters

boolean $pValue

Returns

\PHPExcel_Style_Font

getSubScript()

getSubScript() : boolean

Get SubScript

Returns

boolean

setSubScript()

setSubScript(boolean  $pValue = false) : \PHPExcel_Style_Font

Set SubScript

Parameters

boolean $pValue

Returns

\PHPExcel_Style_Font

getUnderline()

getUnderline() : string

Get Underline

Returns

string

setUnderline()

setUnderline(string|boolean  $pValue = self::UNDERLINE_NONE) : \PHPExcel_Style_Font

Set Underline

Parameters

string|boolean $pValue

PHPExcel_Style_Font underline type If a boolean is passed, then TRUE equates to UNDERLINE_SINGLE, false equates to UNDERLINE_NONE

Returns

\PHPExcel_Style_Font

getStrikethrough()

getStrikethrough() : boolean

Get Strikethrough

Returns

boolean

setStrikethrough()

setStrikethrough(boolean  $pValue = false) : \PHPExcel_Style_Font

Set Strikethrough

Parameters

boolean $pValue

Returns

\PHPExcel_Style_Font

getHashCode()

getHashCode() : string

Get hash code

Returns

string —

Hash code