Constants

UNDERLINE_NONE

UNDERLINE_NONE

UNDERLINE_DOUBLE

UNDERLINE_DOUBLE

UNDERLINE_DOUBLEACCOUNTING

UNDERLINE_DOUBLEACCOUNTING

UNDERLINE_SINGLE

UNDERLINE_SINGLE

UNDERLINE_SINGLEACCOUNTING

UNDERLINE_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