class PHPExcel_RichText implements PHPExcel_IComparable

PHPExcel_RichText

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

Methods

__construct(PHPExcel_Cell $pCell = null)

Create a new PHPExcel_RichText instance

createText(string $pText = '')

Create text

createTextRun(string $pText = '')

Create text run

string
getPlainText()

Get plain text

string
__toString()

Convert to string

setRichTextElements(PHPExcel_RichText_ITextElement[] $pElements = null)

Set Rich Text elements

string
getHashCode()

Get hash code

__clone()

Implement PHP __clone to create a deep clone, not just a shallow copy.

Details

at line 52
__construct(PHPExcel_Cell $pCell = null)

Create a new PHPExcel_RichText instance

Parameters

PHPExcel_Cell $pCell

Exceptions

PHPExcel_Exception

at line 78
PHPExcel_RichText addText(PHPExcel_RichText_ITextElement $pText = null)

Add text

Parameters

PHPExcel_RichText_ITextElement $pText Rich text element

Return Value

PHPExcel_RichText

Exceptions

PHPExcel_Exception

at line 91
PHPExcel_RichText_TextElement createText(string $pText = '')

Create text

Parameters

string $pText Text

Return Value

PHPExcel_RichText_TextElement

Exceptions

PHPExcel_Exception

at line 105
PHPExcel_RichText_Run createTextRun(string $pText = '')

Create text run

Parameters

string $pText Text

Return Value

PHPExcel_RichText_Run

Exceptions

PHPExcel_Exception

at line 117
string getPlainText()

Get plain text

Return Value

string

at line 136
string __toString()

Convert to string

Return Value

string

at line 146
PHPExcel_RichText_ITextElement[] getRichTextElements()

Get Rich Text elements

at line 158
PHPExcel_RichText setRichTextElements(PHPExcel_RichText_ITextElement[] $pElements = null)

Set Rich Text elements

Parameters

PHPExcel_RichText_ITextElement[] $pElements Array of elements

Return Value

PHPExcel_RichText

Exceptions

PHPExcel_Exception

at line 173
string getHashCode()

Get hash code

Return Value

string Hash code

at line 189
__clone()

Implement PHP __clone to create a deep clone, not just a shallow copy.