PHPExcel_RichText

# Class: PHPExcel_RichText Source Location: /PHPExcel/RichText.php
### Class Overview
PHPExcel_RichText #### Author(s): #### Copyright: Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel) Implements interfaces: PHPExcel_IComparable | ### Variables $_parent $_richTextElements | ### Methods __construct addText createText createTextRun getHashCode getParent getPlainText getRichTextElements setParent setRichTextElements __clone __toString
### Class Details [line 65] PHPExcel_RichText PHPExcel_RichText #### Tags:
copyright: | Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
[ Top ] ### Class Variables #### $_parent = [line 79] Parent cell Parent cell #### Tags:
access: | private
Type: | PHPExcel_Cell
[ Top ] #### $_richTextElements = [line 72] Rich text elements Rich text elements #### Tags:
access: | private
Type: | PHPExcel_RichText_ITextElement[]
[ Top ] ### Class Methods ### constructor __construct [line 87]
`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 116]
`PHPExcel_RichText 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 129]
`PHPExcel_RichText_TextElement createText( [string $pText = ''])`
Create text Create text #### Tags:
throws: | Exception
access: | public
#### Parameters:
string | $pText | Text
[ Top ] ### method createTextRun [line 143]
`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 248]
`string getHashCode( )`
Get hash code Get hash code #### Tags:
return: | Hash code
access: | public
[ Top ] ### method getParent [line 210]
`PHPExcel_Cell getParent( )`
Get parent Get parent #### Tags:
access: | public
[ Top ] ### method getPlainText [line 155]
`string getPlainText( )`
Get plain text Get plain text #### Tags:
access: | public
[ Top ] ### method getRichTextElements [line 183]
`PHPExcel_RichText_ITextElement[] getRichTextElements( )`
Get Rich Text elements Get Rich Text elements #### Tags:
access: | public
[ Top ] ### method setParent [line 220]
`PHPExcel_RichText setParent( $value)`
Set parent Set parent #### Tags:
access: | public
#### Parameters:
PHPExcel_Cell | $value |
[ Top ] ### method setRichTextElements [line 195]
`PHPExcel_RichText 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 263]
`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 ] ### method __toString [line 174]
`string __toString( )`
Convert to string Convert to string #### Tags:
access: | public
[ Top ] Documentation generated on Mon, 11 Jan 2010 08:13:18 +0100 by phpDocumentor 1.4.1