PHPExcel_Style

# Class: PHPExcel_Style_Font Source Location: /PHPExcel/Style/Font.php
### Class Overview
PHPExcel_Style_Font #### Author(s): #### Copyright: Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel) Implements interfaces: PHPExcel_IComparable | ### Variables $_bold $_color $_isSupervisor $_italic $_name $_parent $_parentPropertyName $_strikethrough $_subScript $_superScript $_underline | ### Constants UNDERLINE_DOUBLE UNDERLINE_DOUBLEACCOUNTING UNDERLINE_NONE UNDERLINE_SINGLE UNDERLINE_SINGLEACCOUNTING | ### Methods __construct applyFromArray bindParent getActiveCell getActiveSheet getBold getColor getHashCode getIsSupervisor getItalic getName getSelectedCells getSharedComponent getSize getStrikethrough getStriketrough getStyleArray getSubScript getSuperScript getUnderline setBold setColor setItalic setName setSize setStrikethrough setStriketrough setSubScript setSuperScript setUnderline __clone
### Class Details [line 51] PHPExcel_Style_Font PHPExcel_Style_Font #### Tags:
copyright: | Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
[ Top ] ### Class Variables #### $_bold = [line 72] Bold Bold #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_color = [line 114] Foreground color Foreground color #### Tags:
access: | private
Type: | PHPExcel_Style_Color
[ Top ] #### $_isSupervisor = [line 128] Supervisor? Supervisor? #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_italic = [line 79] Italic Italic #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_name = [line 65] Name Name #### Tags:
access: | private
Type: | string
[ Top ] #### $_parent = [line 135] Parent. Parent. Only used for supervisor #### Tags:
access: | private
Type: | PHPExcel_Style
[ Top ] #### $_parentPropertyName = [line 121] Parent Borders Parent Borders #### Tags:
var: | string
access: | private
Type: | _parentPropertyName
[ Top ] #### $_strikethrough = [line 107] Strikethrough Strikethrough #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_subScript = [line 93] Subscript Subscript #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_superScript = [line 86] Superscript Superscript #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_underline = [line 100] Underline Underline #### Tags:
access: | private
Type: | string
[ Top ] ### Class Methods ### constructor __construct [line 140]
`PHPExcel_Style_Font __construct( [ $isSupervisor = false])`
Create a new PHPExcel_Style_Font Create a new PHPExcel_Style_Font #### Tags:
access: | public
#### Parameters:
| $isSupervisor |
[ Top ] ### method applyFromArray [line 259]
`PHPExcel_Style_Font applyFromArray( [array $pStyles = null])`
Apply styles from array 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' ) ) ); #### Tags:
throws: | Exception
access: | public
#### Parameters:
array | $pStyles | Array containing style information
[ Top ] ### method bindParent [line 168]
`PHPExcel_Style_Font bindParent( PHPExcel_Style $parent)`
Bind parent. Bind parent. Only used for supervisor #### Tags:
access: | public
#### Parameters:
PHPExcel_Style | $parent |
[ Top ] ### method getActiveCell [line 221]
`string getActiveCell( )`
Get the currently active cell coordinate in currently active sheet. Get the currently active cell coordinate in currently active sheet. Only used for supervisor #### Tags:
return: | E.g. 'A1'
access: | public
[ Top ] ### method getActiveSheet [line 199]
`PHPExcel_Worksheet getActiveSheet( )`
Get the currently active sheet. Get the currently active sheet. Only used for supervisor #### Tags:
access: | public
[ Top ] ### method getBold [line 365]
`boolean getBold( )`
Get Bold Get Bold #### Tags:
access: | public
[ Top ] ### method getColor [line 574]
`PHPExcel_Style_Color getColor( )`
Get Color Get Color #### Tags:
access: | public
[ Top ] ### method getHashCode [line 603]
`string getHashCode( )`
Get hash code Get hash code #### Tags:
return: | Hash code
access: | public
[ Top ] ### method getIsSupervisor [line 178]
`boolean getIsSupervisor( )`
Is this a supervisor or a real style component? Is this a supervisor or a real style component? #### Tags:
access: | public
[ Top ] ### method getItalic [line 396]
`boolean getItalic( )`
Get Italic Get Italic #### Tags:
access: | public
[ Top ] ### method getName [line 303]
`string getName( )`
Get Name Get Name #### Tags:
access: | public
[ Top ] ### method getSelectedCells [line 210]
`string getSelectedCells( )`
Get the currently active cell coordinate in currently active sheet. Get the currently active cell coordinate in currently active sheet. Only used for supervisor #### Tags:
return: | E.g. 'A1'
access: | public
[ Top ] ### method getSharedComponent [line 189]
`PHPExcel_Style_Font getSharedComponent( )`
Get the shared style component for the currently active cell in currently active sheet. Get the shared style component for the currently active cell in currently active sheet. Only used for style supervisor #### Tags:
access: | public
[ Top ] ### method getSize [line 334]
`double getSize( )`
Get Size Get Size #### Tags:
access: | public
[ Top ] ### method getStrikethrough [line 543]
`boolean getStrikethrough( )`
Get Strikethrough Get Strikethrough #### Tags:
access: | public
[ Top ] ### method getStriketrough [line 523]
`boolean getStriketrough( )`
Get Striketrough Get Striketrough #### Tags:
deprecated: | Use getStrikethrough() instead.
access: | public
[ Top ] ### method getStyleArray [line 232]
`array getStyleArray( array $array)`
Build style array from subcomponents Build style array from subcomponents #### Tags:
access: | public
#### Parameters:
array | $array |
[ Top ] ### method getSubScript [line 459]
`boolean getSubScript( )`
Get SubScript Get SubScript #### Tags:
access: | public
[ Top ] ### method getSuperScript [line 427]
`boolean getSuperScript( )`
Get SuperScript Get SuperScript #### Tags:
access: | public
[ Top ] ### method getUnderline [line 491]
`string getUnderline( )`
Get Underline Get Underline #### Tags:
access: | public
[ Top ] ### method setBold [line 378]
`PHPExcel_Style_Font setBold( [boolean $pValue = false])`
Set Bold Set Bold #### Tags:
access: | public
#### Parameters:
boolean | $pValue |
[ Top ] ### method setColor [line 585]
`PHPExcel_Style_Font setColor( [PHPExcel_Style_Color $pValue = null])`
Set Color Set Color #### Tags:
throws: | Exception
access: | public
#### Parameters:
PHPExcel_Style_Color | $pValue |
[ Top ] ### method setItalic [line 409]
`PHPExcel_Style_Font setItalic( [boolean $pValue = false])`
Set Italic Set Italic #### Tags:
access: | public
#### Parameters:
boolean | $pValue |
[ Top ] ### method setName [line 316]
`PHPExcel_Style_Font setName( [string $pValue = 'Calibri'])`
Set Name Set Name #### Tags:
access: | public
#### Parameters:
string | $pValue |
[ Top ] ### method setSize [line 347]
`PHPExcel_Style_Font setSize( [double $pValue = 10])`
Set Size Set Size #### Tags:
access: | public
#### Parameters:
double | $pValue |
[ Top ] ### method setStrikethrough [line 556]
`PHPExcel_Style_Font setStrikethrough( [boolean $pValue = false])`
Set Strikethrough Set Strikethrough #### Tags:
access: | public
#### Parameters:
boolean | $pValue |
[ Top ] ### method setStriketrough [line 534]
`PHPExcel_Style_Font setStriketrough( [boolean $pValue = false])`
Set Striketrough Set Striketrough #### Tags:
deprecated: | Use setStrikethrough() instead.
access: | public
#### Parameters:
boolean | $pValue |
[ Top ] ### method setSubScript [line 472]
`PHPExcel_Style_Font setSubScript( [boolean $pValue = false])`
Set SubScript Set SubScript #### Tags:
access: | public
#### Parameters:
boolean | $pValue |
[ Top ] ### method setSuperScript [line 440]
`PHPExcel_Style_Font setSuperScript( [boolean $pValue = false])`
Set SuperScript Set SuperScript #### Tags:
access: | public
#### Parameters:
boolean | $pValue |
[ Top ] ### method setUnderline [line 504]
`PHPExcel_Style_Font setUnderline( [string $pValue = PHPExcel_Style_Font::UNDERLINE_NONE])`
Set Underline Set Underline #### Tags:
access: | public
#### Parameters:
string | $pValue | PHPExcel_Style_Font underline type
[ Top ] ### method __clone [line 624]
`void __clone( )`
Implement PHP __clone to create a deep clone, not just a shallow copy. Implement PHP __clone to create a deep clone, not just a shallow copy. #### Tags:
access: | public
[ Top ] ### Class Constants #### UNDERLINE_DOUBLE = 'double' [line 55] [ Top ] #### UNDERLINE_DOUBLEACCOUNTING = 'doubleAccounting' [line 56] [ Top ] #### UNDERLINE_NONE = 'none' [line 54] [ Top ] #### UNDERLINE_SINGLE = 'single' [line 57] [ Top ] #### UNDERLINE_SINGLEACCOUNTING = 'singleAccounting' [line 58] [ Top ] Documentation generated on Mon, 11 Jan 2010 08:09:32 +0100 by phpDocumentor 1.4.1