PHPExcel_RichText
[ class tree: PHPExcel_RichText ] [ index: PHPExcel_RichText ] [ 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:
ITextElement.php
RichText.php
Run.php
TextElement.php

Interfaces:
PHPExcel_RichText_ITextElement
Classes:
PHPExcel_RichText
PHPExcel_RichText_Run
PHPExcel_RichText_TextElement

Class: PHPExcel_RichText

Source Location: /PHPExcel/RichText.php

Class Overview




PHPExcel_RichText




Author(s):


    
        





      
  


Copyright:


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


                

            Implements interfaces:
            

        

        




Variables







Methods
























Class Details



[line 54]

PHPExcel_RichText

PHPExcel_RichText





Tags:





  

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










[ Top ]







Class Variables



	
	

	
$_hashIndex = 

	
[line 239]

  Hash index

Hash index





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_parent = 

	
[line 68]

  Parent cell

Parent cell





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Cell
    

      

	



	
[ Top ]


	
	

	
$_richTextElements = 

	
[line 61]

  Rich text elements

Rich text elements





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_RichText_ITextElement[]
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 76]

	

    

    

		PHPExcel_RichText __construct(
[
$pCell = null], PHPExcel_Cell
$pParent)
    

    


	
		Create a new PHPExcel_RichText instance

Create a new PHPExcel_RichText instance





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Cell  
        $pParent  
        
      

          

        PHPExcel_Cell  
        $pCell  
        
      

        

    


        
[ Top ]

  

  

	
	
method addText [line 104]

	

    

    

		void addText(
[PHPExcel_RichText_ITextElement
$pText = null])
    

    


	
		Add text

Add text





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_RichText_ITextElement  
        $pText  
        Rich text element
      

        

    


        
[ Top ]

  

  

	
	
method createText [line 116]

	

    

    

		PHPExcel_RichText_TextElement createText(
[string
$pText = ''])
    

    


	
		Create text

Create text





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pText  
        Text
      

        

    


        
[ Top ]

  

  

	
	
method createTextRun [line 130]

	

    

    

		PHPExcel_RichText_Run createTextRun(
[string
$pText = ''])
    

    


	
		Create text run

Create text run





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pText  
        Text
      

        

    


        
[ Top ]

  

  

	
	
method getHashCode [line 222]

	

    

    

		string getHashCode(
)
    

    


	
		Get hash code

Get hash code





Tags:





  

    return:  Hash code
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashIndex [line 249]

	

    

    

		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 getParent [line 186]

	

    

    

		PHPExcel_Cell getParent(
)
    

    


	
		Get parent

Get parent





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getPlainText [line 142]

	

    

    

		string getPlainText(
)
    

    


	
		Get plain text

Get plain text





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getRichTextElements [line 161]

	

    

    

		PHPExcel_RichText_ITextElement[] getRichTextElements(
)
    

    


	
		Get Rich Text elements

Get Rich Text elements





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method setHashIndex [line 261]

	

    

    

		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 setParent [line 195]

	

    

    

		void setParent(

$value)
    

    


	
		Set parent

Set parent





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Cell  
        $value  
        
      

        

    


        
[ Top ]

  

  

	
	
method setRichTextElements [line 172]

	

    

    

		void setRichTextElements(
[PHPExcel_RichText_ITextElement[]
$pElements = null])
    

    


	
		Set Rich Text elements

Set Rich Text elements





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_RichText_ITextElement[]  
        $pElements  
        Array of elements
      

        

    


        
[ Top ]

  

  

	
	
method __clone [line 268]

	

    

    

		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 ]

  






        

		    

		    Documentation generated on Mon, 05 Jan 2009 20:38:27 +0100 by phpDocumentor 1.4.1