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

$colorIndex

$colorIndex : int

Type

int

$isSupervisor

$isSupervisor : bool

Supervisor?

Type

bool

$parent

$parent : \PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style

Parent. Only used for supervisor.

Type

Style

$parentPropertyName

$parentPropertyName : null|string

Parent property name.

Type

null|string

$name

$name : string

Font Name.

Type

string

$size

$size : float

Font Size.

Type

float

$bold

$bold : bool

Bold.

Type

bool

$italic

$italic : bool

Italic.

Type

bool

$superscript

$superscript : bool

Superscript.

Type

bool

$subscript

$subscript : bool

Subscript.

Type

bool

$underline

$underline : string

Underline.

Type

string

$strikethrough

$strikethrough : bool

Strikethrough.

Type

bool

$color

$color : \PhpOffice\PhpSpreadsheet\Style\Color

Foreground color.

Type

Color

Methods

__construct()

__construct(bool  $isSupervisor = false, bool  $isConditional = false) : mixed

Create a new Font.

Parameters

bool $isSupervisor

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

bool $isConditional

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

Returns

mixed —

bindParent()

bindParent(\PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style  $parent, null|string  $parentPropertyName = null) : \PhpOffice\PhpSpreadsheet\Style\Supervisor

Bind parent. Only used for supervisor.

Parameters

\PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style $parent
null|string $parentPropertyName

Returns

\PhpOffice\PhpSpreadsheet\Style\Supervisor —

getIsSupervisor()

getIsSupervisor() : bool

Is this a supervisor or a cell style component?

Returns

bool —

getActiveSheet()

getActiveSheet() : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Get the currently active sheet. Only used for supervisor.

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\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() : mixed

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

Returns

mixed —

getSharedComponent()

getSharedComponent() : \PhpOffice\PhpSpreadsheet\Style\Font

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

Only used for style supervisor.

Returns

\PhpOffice\PhpSpreadsheet\Style\Font —

getStyleArray()

getStyleArray(array  $array) : array

Build style array from subcomponents.

Parameters

array $array

Returns

array —

applyFromArray()

applyFromArray(array  $pStyles) : \PhpOffice\PhpSpreadsheet\Style\Font

Apply styles from array.

$spreadsheet->getActiveSheet()->getStyle('B2')->getFont()->applyFromArray( [ 'name' => 'Arial', 'bold' => TRUE, 'italic' => FALSE, 'underline' => \PhpOffice\PhpSpreadsheet\Style\Font::UNDERLINE_DOUBLE, 'strikethrough' => FALSE, 'color' => [ 'rgb' => '808080' ] ] );

Parameters

array $pStyles

Array containing style information

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

\PhpOffice\PhpSpreadsheet\Style\Font —

getName()

getName() : string

Get Name.

Returns

string —

setName()

setName(string  $pValue) : \PhpOffice\PhpSpreadsheet\Style\Font

Set Name.

Parameters

string $pValue

Returns

\PhpOffice\PhpSpreadsheet\Style\Font —

getSize()

getSize() : float

Get Size.

Returns

float —

setSize()

setSize(float  $pValue) : \PhpOffice\PhpSpreadsheet\Style\Font

Set Size.

Parameters

float $pValue

Returns

\PhpOffice\PhpSpreadsheet\Style\Font —

getBold()

getBold() : bool

Get Bold.

Returns

bool —

setBold()

setBold(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Style\Font

Set Bold.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Style\Font —

getItalic()

getItalic() : bool

Get Italic.

Returns

bool —

setItalic()

setItalic(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Style\Font

Set Italic.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Style\Font —

getSuperscript()

getSuperscript() : bool

Get Superscript.

Returns

bool —

setSuperscript()

setSuperscript(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Style\Font

Set Superscript.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Style\Font —

getSubscript()

getSubscript() : bool

Get Subscript.

Returns

bool —

setSubscript()

setSubscript(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Style\Font

Set Subscript.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Style\Font —

getUnderline()

getUnderline() : string

Get Underline.

Returns

string —

setUnderline()

setUnderline(bool|string  $pValue) : \PhpOffice\PhpSpreadsheet\Style\Font

Set Underline.

Parameters

bool|string $pValue

\PhpOffice\PhpSpreadsheet\Style\Font underline type If a boolean is passed, then TRUE equates to UNDERLINE_SINGLE, false equates to UNDERLINE_NONE

Returns

\PhpOffice\PhpSpreadsheet\Style\Font —

getStrikethrough()

getStrikethrough() : bool

Get Strikethrough.

Returns

bool —

setStrikethrough()

setStrikethrough(bool  $pValue) : \PhpOffice\PhpSpreadsheet\Style\Font

Set Strikethrough.

Parameters

bool $pValue

Returns

\PhpOffice\PhpSpreadsheet\Style\Font —

getColor()

getColor() : \PhpOffice\PhpSpreadsheet\Style\Color

Get Color.

Returns

\PhpOffice\PhpSpreadsheet\Style\Color —

setColor()

setColor(\PhpOffice\PhpSpreadsheet\Style\Color  $pValue) : \PhpOffice\PhpSpreadsheet\Style\Font

Set Color.

Parameters

\PhpOffice\PhpSpreadsheet\Style\Color $pValue

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

\PhpOffice\PhpSpreadsheet\Style\Font —

getHashCode()

getHashCode() : string

Get hash code.

Returns

string —

Hash code