\PHPExcel_Style

PHPExcel_Style

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()
getParent()
getStyleArray()
applyFromArray()
getFill()
getFont()
setFont()
getBorders()
getAlignment()
getNumberFormat()
getConditionalStyles()
setConditionalStyles()
getProtection()
getQuotePrefix()
setQuotePrefix()
getHashCode()
getIndex()
setIndex()
No public properties found
No constants found
No protected methods found
$isSupervisor
$parent
$font
$fill
$borders
$alignment
$numberFormat
$conditionalStyles
$protection
$index
$quotePrefix
N/A
No private methods found
No private properties found
N/A

Properties

$isSupervisor

$isSupervisor : boolean

Supervisor?

Type

boolean

$parent

$parent : \PHPExcel_Style

Parent. Only used for supervisor

Type

\PHPExcel_Style

$conditionalStyles

$conditionalStyles : array<mixed,\PHPExcel_Style_Conditional>

Conditional styles

Type

array<mixed,\PHPExcel_Style_Conditional>

$index

$index : integer

Index of style in collection. Only used for real style.

Type

integer

$quotePrefix

$quotePrefix : boolean

Use Quote Prefix when displaying in cell editor. Only used for real style.

Type

boolean

Methods

__construct()

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

Create a new PHPExcel_Style

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

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

Only used for style supervisor

Returns

\PHPExcel_Style

getParent()

getParent() : \PHPExcel

Get parent. Only used for style supervisor

Returns

\PHPExcel

getStyleArray()

getStyleArray(array  $array) : array

Build style array from subcomponents

Parameters

array $array

Returns

array

applyFromArray()

applyFromArray(array  $pStyles = null, boolean  $pAdvanced = true) : \PHPExcel_Style

Apply styles from array

$objPHPExcel->getActiveSheet()->getStyle('B2')->applyFromArray( array( 'font' => array( 'name' => 'Arial', 'bold' => true, 'italic' => false, 'underline' => PHPExcel_Style_Font::UNDERLINE_DOUBLE, 'strike' => false, 'color' => array( 'rgb' => '808080' ) ), 'borders' => array( 'bottom' => array( 'style' => PHPExcel_Style_Border::BORDER_DASHDOT, 'color' => array( 'rgb' => '808080' ) ), 'top' => array( 'style' => PHPExcel_Style_Border::BORDER_DASHDOT, 'color' => array( 'rgb' => '808080' ) ) ), 'quotePrefix' => true ) );

Parameters

array $pStyles

Array containing style information

boolean $pAdvanced

Advanced mode for setting borders.

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Style

getConditionalStyles()

getConditionalStyles() : array<mixed,\PHPExcel_Style_Conditional>

Get Conditional Styles. Only used on supervisor.

Returns

array<mixed,\PHPExcel_Style_Conditional>

setConditionalStyles()

setConditionalStyles(array<mixed,\PHPExcel_Style_Conditional>  $pValue = null) : \PHPExcel_Style

Set Conditional Styles. Only used on supervisor.

Parameters

array<mixed,\PHPExcel_Style_Conditional> $pValue

Array of condtional styles

Returns

\PHPExcel_Style

getQuotePrefix()

getQuotePrefix() : boolean

Get quote prefix

Returns

boolean

setQuotePrefix()

setQuotePrefix(boolean  $pValue) 

Set quote prefix

Parameters

boolean $pValue

getHashCode()

getHashCode() : string

Get hash code

Returns

string —

Hash code

getIndex()

getIndex() : integer

Get own index in style collection

Returns

integer

setIndex()

setIndex(integer  $pValue) 

Set own index in style collection

Parameters

integer $pValue