PHPExcel_Style
[ class tree: PHPExcel_Style ] [ index: PHPExcel_Style ] [ all elements ]
Packages:
default
JAMA
Math_Stats
PHPExcel
PHPExcel_Calculation
PHPExcel_Cell
PHPExcel_Reader
PHPExcel_Reader_Excel5
PHPExcel_RichText
PHPExcel_Shared
PHPExcel_Shared_Escher
PHPExcel_Shared_OLE
PHPExcel_Style
PHPExcel_Worksheet
PHPExcel_Worksheet_Drawing
PHPExcel_Writer
PHPExcel_Writer_Excel5
PHPExcel_Writer_Excel2007


Files:
Alignment.php
Border.php
Borders.php
Color.php
Conditional.php
Fill.php
Font.php
NumberFormat.php
Protection.php
Style.php

Classes:
PHPExcel_Style
PHPExcel_Style_Alignment
PHPExcel_Style_Border
PHPExcel_Style_Borders
PHPExcel_Style_Color
PHPExcel_Style_Conditional
PHPExcel_Style_Fill
PHPExcel_Style_Font
PHPExcel_Style_NumberFormat
PHPExcel_Style_Protection

Class: PHPExcel_Style_Font

Source Location: /PHPExcel/Style/Font.php

Class Overview




PHPExcel_Style_Font




Author(s):


    
        





      
  


Copyright:


    
  
  • Copyright (c) 2006 - 2009 PHPExcel (http://www.codeplex.com/PHPExcel)
    • 


                

            Implements interfaces:
            

        

        




Variables






Constants






Methods
























Class Details



[line 43]

PHPExcel_Style_Font

PHPExcel_Style_Font





Tags:





  

    copyright:  Copyright (c) 2006 - 2009 PHPExcel (http://www.codeplex.com/PHPExcel)
  










[ Top ]







Class Variables



	
	

	
$_bold = 

	
[line 64]

  Bold

Bold





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_color = 

	
[line 106]

  Foreground color

Foreground color





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Color
    

      

	



	
[ Top ]


	
	

	
$_hashIndex = 

	
[line 465]

  Hash index

Hash index





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_italic = 

	
[line 71]

  Italic

Italic





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_name = 

	
[line 57]

  Name

Name





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_parent = 

	
[line 114]

  Parent Style

Parent Style





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style
    

      

	



	
[ Top ]


	
	

	
$_parentPropertyName = 

	
[line 121]

  Parent Borders

Parent Borders





Tags:





  

    var:  string
  

  

    access:  private
  






  

	

  

    

      Type:  
      _parentPropertyName
    

      

	



	
[ Top ]


	
	

	
$_striketrough = 

	
[line 99]

  Striketrough

Striketrough





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_subScript = 

	
[line 85]

  Subscript

Subscript





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_superScript = 

	
[line 78]

  Superscript

Superscript





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_underline = 

	
[line 92]

  Underline

Underline





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 126]

	

    

    

		PHPExcel_Style_Font __construct(
)
    

    


	
		Create a new PHPExcel_Style_Font

Create a new PHPExcel_Style_Font





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method applyFromArray [line 214]

	

    

    

		void applyFromArray(
[array
$pStyles = null])
    

    


	
		Apply styles from array

Apply styles from array
 
  1.  $objPHPExcel->getActiveSheet()->getStyle('B2')->getFont()->applyFromArray(
    2. 

  2.          array(
    3. 

  3.              'name'      => 'Arial',
    4. 

  4.              'bold'      => true,
    5. 

  5.              'italic'    => false,
    6. 

  6.              'underline' => PHPExcel_Style_Font::UNDERLINE_DOUBLE,
    7. 

  7.              'strike'    => false,
    8. 

  8.              'color'     => array(
    9. 

  9.                  'rgb' => '808080'
    10. 

  10.              )
    11. 

  11.          )
    12. 

  12.  );
    13. 






Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $pStyles  
        Array containing style information
      

        

    


        
[ Top ]

  

  

	
	
method getBold [line 295]

	

    

    

		boolean getBold(
)
    

    


	
		Get Bold

Get Bold





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getColor [line 423]

	

    

    

		PHPExcel_Style_Color getColor(
)
    

    


	
		Get Color

Get Color





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashCode [line 444]

	

    

    

		string getHashCode(
)
    

    


	
		Get hash code

Get hash code





Tags:





  

    return:  Hash code
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashIndex [line 475]

	

    

    

		string getHashIndex(
)
    

    


	
		Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.





Tags:





  

    return:  Hash index
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getItalic [line 316]

	

    

    

		boolean getItalic(
)
    

    


	
		Get Italic

Get Italic





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getName [line 253]

	

    

    

		string getName(
)
    

    


	
		Get Name

Get Name





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSize [line 274]

	

    

    

		double getSize(
)
    

    


	
		Get Size

Get Size





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getStriketrough [line 402]

	

    

    

		boolean getStriketrough(
)
    

    


	
		Get Striketrough

Get Striketrough





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSubScript [line 359]

	

    

    

		boolean getSubScript(
)
    

    


	
		Get SubScript

Get SubScript





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSuperScript [line 337]

	

    

    

		boolean getSuperScript(
)
    

    


	
		Get SuperScript

Get SuperScript





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getUnderline [line 381]

	

    

    

		string getUnderline(
)
    

    


	
		Get Underline

Get Underline





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method propertyBeginBind [line 180]

	

    

    

		PHPExcel_Style_Font propertyBeginBind(
)
    

    


	
		Property Begin Bind
 If no PHPExcel_Style_Font has been bound to PHPExcel_Style then bind this one.

Property Begin Bind
 If no PHPExcel_Style_Font has been bound to PHPExcel_Style then bind this one. Return the actual bound one.





Tags:





  

    access:  private
  









	
        
[ Top ]

  

  

	
	
method propertyGetBound [line 163]

	

    

    

		PHPExcel_Style_Font propertyGetBound(
)
    

    


	
		Property Get Bound

Property Get Bound
 Returns the PHPExcel_Style_Font that is actual bound to PHPExcel_Style





Tags:





  

    access:  private
  









	
        
[ Top ]

  

  

	
	
method propertyPrepareBind [line 148]

	

    

    

		void propertyPrepareBind(
$parent
$parent, $parentPropertyName
$parentPropertyName)
    

    


	
		Property Prepare bind

Property Prepare bind
 Configures this object for late binding as a property of a parent object





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        $parent  
        $parent  
        
      

          

        $parentPropertyName  
        $parentPropertyName  
        
      

        

    


        
[ Top ]

  

  

	
	
method setBold [line 304]

	

    

    

		void setBold(
[boolean
$pValue = false])
    

    


	
		Set Bold

Set Bold





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setColor [line 435]

	

    

    

		void setColor(
[PHPExcel_Style_Color
$pValue = null])
    

    


	
		Set Color

Set Color





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Style_Color  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setHashIndex [line 487]

	

    

    

		void setHashIndex(
string
$value)
    

    


	
		Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $value  
        Hash index
      

        

    


        
[ Top ]

  

  

	
	
method setItalic [line 325]

	

    

    

		void setItalic(
[boolean
$pValue = false])
    

    


	
		Set Italic

Set Italic





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setName [line 262]

	

    

    

		void setName(
[string
$pValue = 'Calibri'])
    

    


	
		Set Name

Set Name





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setSize [line 283]

	

    

    

		void setSize(
[double
$pValue = 10])
    

    


	
		Set Size

Set Size





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        double  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setStriketrough [line 411]

	

    

    

		void setStriketrough(
[boolean
$pValue = false])
    

    


	
		Set Striketrough

Set Striketrough





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setSubScript [line 368]

	

    

    

		void setSubScript(
[boolean
$pValue = false])
    

    


	
		Set SubScript

Set SubScript





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setSuperScript [line 346]

	

    

    

		void setSuperScript(
[boolean
$pValue = false])
    

    


	
		Set SuperScript

Set SuperScript





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setUnderline [line 390]

	

    

    

		void 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 494]

	

    

    

		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 47]

  
  

	
[ Top ]


	
	

	
UNDERLINE_DOUBLEACCOUNTING =  'doubleAccounting'

	
[line 48]

  
  

	
[ Top ]


	
	

	
UNDERLINE_NONE =  'none'

	
[line 46]

  
  

	
[ Top ]


	
	

	
UNDERLINE_SINGLE =  'single'

	
[line 49]

  
  

	
[ Top ]


	
	

	
UNDERLINE_SINGLEACCOUNTING =  'singleAccounting'

	
[line 50]

  
  

	
[ Top ]






        

		    

		    Documentation generated on Mon, 05 Jan 2009 20:37:14 +0100 by phpDocumentor 1.4.1