You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

306 lines
18 KiB

  1. <!DOCTYPE html><html lang="en">
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  4. <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
  5. <meta charset="utf-8">
  6. <title>PHPExcel classes » \PHPExcel_RichText</title>
  7. <meta name="author" content="Mike van Riel">
  8. <meta name="description" content="">
  9. <link href="../css/template.css" rel="stylesheet" media="all">
  10. <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
  11. <link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
  12. <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
  13. <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
  14. </head>
  15. <body>
  16. <div class="navbar navbar-fixed-top">
  17. <div class="navbar-inner"><div class="container">
  18. <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">PHPExcel classes</a><div class="nav-collapse"><ul class="nav">
  19. <li class="dropdown">
  20. <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
  21. API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
  22. <li><a>Packages</a></li>
  23. <li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
  24. <li><a href="../packages/JAMA.html"><i class="icon-folder-open"></i> JAMA</a></li>
  25. <li><a href="../packages/JAMA%0D%0ACholesky%20decomposition%20class%0D%0AFor%20a%20symmetric,%20positive%20definite%20matrix%20A,%20the%20Cholesky%20decomposition%0D%0Ais%20an%20lower%20triangular%20matrix%20L%20so%20that%20A%20=%20L*L'.html"><i class="icon-folder-open"></i> JAMA
  26. Cholesky decomposition class
  27. For a symmetric, positive definite matrix A, the Cholesky decomposition
  28. is an lower triangular matrix L so that A = L*L'</a></li>
  29. <li><a href="../packages/JAMA%0D%0AClass%20to%20obtain%20eigenvalues%20and%20eigenvectors%20of%20a%20real%20matrix.html"><i class="icon-folder-open"></i> JAMA
  30. Class to obtain eigenvalues and eigenvectors of a real matrix</a></li>
  31. <li><a href="../packages/JAMA%0D%0AError%20handling.html"><i class="icon-folder-open"></i> JAMA
  32. Error handling</a></li>
  33. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20LU%20decomposition%20is%20an%20m-by-n%0D%0Aunit%20lower%20triangular%20matrix%20L,%20an%20n-by-n%20upper%20triangular%20matrix%20U,%0D%0Aand%20a%20permutation%20vector%20piv%20of%20length%20m%20so%20that%20A(piv,:)%20=%20L*U.html"><i class="icon-folder-open"></i> JAMA
  34. For an m-by-n matrix A with m &gt;= n, the LU decomposition is an m-by-n
  35. unit lower triangular matrix L, an n-by-n upper triangular matrix U,
  36. and a permutation vector piv of length m so that A(piv,:) = L*U</a></li>
  37. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20QR%20decomposition%20is%20an%20m-by-n%0D%0Aorthogonal%20matrix%20Q%20and%20an%20n-by-n%20upper%20triangular%20matrix%20R%20so%20that%0D%0AA%20=%20Q*R.html"><i class="icon-folder-open"></i> JAMA
  38. For an m-by-n matrix A with m &gt;= n, the QR decomposition is an m-by-n
  39. orthogonal matrix Q and an n-by-n upper triangular matrix R so that
  40. A = Q*R</a></li>
  41. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20singular%20value%20decomposition%20is%0D%0Aan%20m-by-n%20orthogonal%20matrix%20U,%20an%20n-by-n%20diagonal%20matrix%20S,%20and%0D%0Aan%20n-by-n%20orthogonal%20matrix%20V%20so%20that%20A%20=%20U*S*V'.html"><i class="icon-folder-open"></i> JAMA
  42. For an m-by-n matrix A with m &gt;= n, the singular value decomposition is
  43. an m-by-n orthogonal matrix U, an n-by-n diagonal matrix S, and
  44. an n-by-n orthogonal matrix V so that A = U*S*V'</a></li>
  45. <li><a href="../packages/JAMA%0D%0APythagorean%20Theorem:%0D%0Aa%20=%203%0D%0Ab%20=%204%0D%0Ar%20=%20sqrt(square(a)%20+%20square(b))%0D%0Ar%20=%205%0D%0Ar%20=%20sqrt(a%5E2%20+%20b%5E2)%20without%20under.overflow.html"><i class="icon-folder-open"></i> JAMA
  46. Pythagorean Theorem:
  47. a = 3
  48. b = 4
  49. r = sqrt(square(a) + square(b))
  50. r = 5
  51. r = sqrt(a^2 + b^2) without under/overflow</a></li>
  52. <li><a href="../packages/PHPExcel.html"><i class="icon-folder-open"></i> PHPExcel</a></li>
  53. </ul>
  54. </li>
  55. <li class="dropdown" id="charts-menu">
  56. <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
  57. Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
  58. </li>
  59. <li class="dropdown" id="reports-menu">
  60. <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
  61. Reports <b class="caret"></b></a><ul class="dropdown-menu">
  62. <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
  63. <span class="label label-info">551</span></a></li>
  64. <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
  65. <ul>
  66. <li>todo 
  67. <span class="label label-info">19</span>
  68. </li>
  69. <li>fixme 
  70. <span class="label label-info">10</span>
  71. </li>
  72. </ul></a></li>
  73. <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
  74. <span class="label label-info">12</span></a></li>
  75. </ul>
  76. </li>
  77. </ul></div>
  78. </div></div>
  79. <div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
  80. </div>
  81. <div id="___" class="container">
  82. <noscript><div class="alert alert-warning">
  83. Javascript is disabled; several features are only available
  84. if Javascript is enabled.
  85. </div></noscript>
  86. <div class="row">
  87. <div class="span4">
  88. <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
  89. <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
  90. </div>
  91. <ul class="side-nav nav nav-list">
  92. <li class="nav-header">
  93. <i class="icon-custom icon-method"></i> Methods
  94. <ul>
  95. <li class="method public "><a href="#method___clone" title="__clone :: Implement PHP __clone to create a deep clone, not just a shallow copy."><span class="description">Implement PHP __clone to create a deep clone, not just a shallow copy.</span><pre>__clone()</pre></a></li>
  96. <li class="method public "><a href="#method___construct" title="__construct :: Create a new PHPExcel_RichText instance"><span class="description">Create a new PHPExcel_RichText instance</span><pre>__construct()</pre></a></li>
  97. <li class="method public "><a href="#method___toString" title="__toString :: Convert to string"><span class="description">Convert to string</span><pre>__toString()</pre></a></li>
  98. <li class="method public "><a href="#method_addText" title="addText :: Add text"><span class="description">Add text</span><pre>addText()</pre></a></li>
  99. <li class="method public "><a href="#method_createText" title="createText :: Create text"><span class="description">Create text</span><pre>createText()</pre></a></li>
  100. <li class="method public "><a href="#method_createTextRun" title="createTextRun :: Create text run"><span class="description">Create text run</span><pre>createTextRun()</pre></a></li>
  101. <li class="method public "><a href="#method_getHashCode" title="getHashCode :: Get hash code"><span class="description">Get hash code</span><pre>getHashCode()</pre></a></li>
  102. <li class="method public "><a href="#method_getPlainText" title="getPlainText :: Get plain text"><span class="description">Get plain text</span><pre>getPlainText()</pre></a></li>
  103. <li class="method public "><a href="#method_getRichTextElements" title="getRichTextElements :: Get Rich Text elements"><span class="description">Get Rich Text elements</span><pre>getRichTextElements()</pre></a></li>
  104. <li class="method public "><a href="#method_setRichTextElements" title="setRichTextElements :: Set Rich Text elements"><span class="description">Set Rich Text elements</span><pre>setRichTextElements()</pre></a></li>
  105. </ul>
  106. </li>
  107. <li class="nav-header">
  108. <i class="icon-custom icon-property"></i> Properties
  109. <ul></ul>
  110. </li>
  111. <li class="nav-header private">» Private
  112. <ul><li class="property private "><a href="#property__richTextElements" title="$_richTextElements :: Rich text elements"><span class="description"></span><pre>$_richTextElements</pre></a></li></ul>
  113. </li>
  114. </ul>
  115. </div>
  116. <div class="span8">
  117. <a id="\PHPExcel_RichText"></a><ul class="breadcrumb">
  118. <li>
  119. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  120. </li>
  121. <li><a href="../namespaces/global.html">global</a></li>
  122. <li class="active">
  123. <span class="divider">\</span><a href="../classes/PHPExcel_RichText.html">PHPExcel_RichText</a>
  124. </li>
  125. </ul>
  126. <div class="element class">
  127. <p class="short_description">PHPExcel_RichText</p>
  128. <div class="details">
  129. <div class="long_description"></div>
  130. <table class="table table-bordered">
  131. <tr>
  132. <th>category</th>
  133. <td>PHPExcel</td>
  134. </tr>
  135. <tr>
  136. <th>package</th>
  137. <td><a href="../packages/PHPExcel.RichText.html">PHPExcel_RichText</a></td>
  138. </tr>
  139. <tr>
  140. <th>copyright</th>
  141. <td>Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)</td>
  142. </tr>
  143. </table>
  144. <h3>
  145. <i class="icon-custom icon-method"></i> Methods</h3>
  146. <a id="method___clone"></a><div class="element clickable method public method___clone" data-toggle="collapse" data-target=".method___clone .collapse">
  147. <h2>Implement PHP __clone to create a deep clone, not just a shallow copy.</h2>
  148. <pre>__clone() </pre>
  149. <div class="labels"></div>
  150. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  151. </div>
  152. <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
  153. <h2>Create a new PHPExcel_RichText instance</h2>
  154. <pre>__construct(\PHPExcel_Cell $pCell) </pre>
  155. <div class="labels"></div>
  156. <div class="row collapse"><div class="detail-description">
  157. <div class="long_description"></div>
  158. <h3>Parameters</h3>
  159. <div class="subelement argument">
  160. <h4>$pCell</h4>
  161. <code><a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></code>
  162. </div>
  163. <h3>Exceptions</h3>
  164. <table class="table table-bordered"><tr>
  165. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>
  166. <td></td>
  167. </tr></table>
  168. </div></div>
  169. </div>
  170. <a id="method___toString"></a><div class="element clickable method public method___toString" data-toggle="collapse" data-target=".method___toString .collapse">
  171. <h2>Convert to string</h2>
  172. <pre>__toString() : string</pre>
  173. <div class="labels"></div>
  174. <div class="row collapse"><div class="detail-description">
  175. <div class="long_description"></div>
  176. <h3>Returns</h3>
  177. <div class="subelement response"><code>string</code></div>
  178. </div></div>
  179. </div>
  180. <a id="method_addText"></a><div class="element clickable method public method_addText" data-toggle="collapse" data-target=".method_addText .collapse">
  181. <h2>Add text</h2>
  182. <pre>addText(\PHPExcel_RichText_ITextElement $pText) : <a href="../classes/PHPExcel_RichText.html">\PHPExcel_RichText</a></pre>
  183. <div class="labels"></div>
  184. <div class="row collapse"><div class="detail-description">
  185. <div class="long_description"></div>
  186. <h3>Parameters</h3>
  187. <div class="subelement argument">
  188. <h4>$pText</h4>
  189. <code><a href="../classes/PHPExcel_RichText_ITextElement.html">\PHPExcel_RichText_ITextElement</a></code><p>Rich text element</p></div>
  190. <h3>Exceptions</h3>
  191. <table class="table table-bordered"><tr>
  192. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>
  193. <td></td>
  194. </tr></table>
  195. <h3>Returns</h3>
  196. <div class="subelement response"><code><a href="../classes/PHPExcel_RichText.html">\PHPExcel_RichText</a></code></div>
  197. </div></div>
  198. </div>
  199. <a id="method_createText"></a><div class="element clickable method public method_createText" data-toggle="collapse" data-target=".method_createText .collapse">
  200. <h2>Create text</h2>
  201. <pre>createText(string $pText) : <a href="../classes/PHPExcel_RichText_TextElement.html">\PHPExcel_RichText_TextElement</a></pre>
  202. <div class="labels"></div>
  203. <div class="row collapse"><div class="detail-description">
  204. <div class="long_description"></div>
  205. <h3>Parameters</h3>
  206. <div class="subelement argument">
  207. <h4>$pText</h4>
  208. <code>string</code><p>Text</p></div>
  209. <h3>Exceptions</h3>
  210. <table class="table table-bordered"><tr>
  211. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>
  212. <td></td>
  213. </tr></table>
  214. <h3>Returns</h3>
  215. <div class="subelement response"><code><a href="../classes/PHPExcel_RichText_TextElement.html">\PHPExcel_RichText_TextElement</a></code></div>
  216. </div></div>
  217. </div>
  218. <a id="method_createTextRun"></a><div class="element clickable method public method_createTextRun" data-toggle="collapse" data-target=".method_createTextRun .collapse">
  219. <h2>Create text run</h2>
  220. <pre>createTextRun(string $pText) : <a href="../classes/PHPExcel_RichText_Run.html">\PHPExcel_RichText_Run</a></pre>
  221. <div class="labels"></div>
  222. <div class="row collapse"><div class="detail-description">
  223. <div class="long_description"></div>
  224. <h3>Parameters</h3>
  225. <div class="subelement argument">
  226. <h4>$pText</h4>
  227. <code>string</code><p>Text</p></div>
  228. <h3>Exceptions</h3>
  229. <table class="table table-bordered"><tr>
  230. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>
  231. <td></td>
  232. </tr></table>
  233. <h3>Returns</h3>
  234. <div class="subelement response"><code><a href="../classes/PHPExcel_RichText_Run.html">\PHPExcel_RichText_Run</a></code></div>
  235. </div></div>
  236. </div>
  237. <a id="method_getHashCode"></a><div class="element clickable method public method_getHashCode" data-toggle="collapse" data-target=".method_getHashCode .collapse">
  238. <h2>Get hash code</h2>
  239. <pre>getHashCode() : string</pre>
  240. <div class="labels"></div>
  241. <div class="row collapse"><div class="detail-description">
  242. <div class="long_description"></div>
  243. <h3>Returns</h3>
  244. <div class="subelement response">
  245. <code>string</code>Hash code</div>
  246. </div></div>
  247. </div>
  248. <a id="method_getPlainText"></a><div class="element clickable method public method_getPlainText" data-toggle="collapse" data-target=".method_getPlainText .collapse">
  249. <h2>Get plain text</h2>
  250. <pre>getPlainText() : string</pre>
  251. <div class="labels"></div>
  252. <div class="row collapse"><div class="detail-description">
  253. <div class="long_description"></div>
  254. <h3>Returns</h3>
  255. <div class="subelement response"><code>string</code></div>
  256. </div></div>
  257. </div>
  258. <a id="method_getRichTextElements"></a><div class="element clickable method public method_getRichTextElements" data-toggle="collapse" data-target=".method_getRichTextElements .collapse">
  259. <h2>Get Rich Text elements</h2>
  260. <pre>getRichTextElements() : <a href="PHPExcel.RichText.ITextElement.html#%5CPHPExcel_RichText_ITextElement">\PHPExcel_RichText_ITextElement[]</a></pre>
  261. <div class="labels"></div>
  262. <div class="row collapse"><div class="detail-description">
  263. <div class="long_description"></div>
  264. <h3>Returns</h3>
  265. <div class="subelement response"><code><a href="PHPExcel.RichText.ITextElement.html#%5CPHPExcel_RichText_ITextElement">\PHPExcel_RichText_ITextElement[]</a></code></div>
  266. </div></div>
  267. </div>
  268. <a id="method_setRichTextElements"></a><div class="element clickable method public method_setRichTextElements" data-toggle="collapse" data-target=".method_setRichTextElements .collapse">
  269. <h2>Set Rich Text elements</h2>
  270. <pre>setRichTextElements(<a href="PHPExcel.RichText.ITextElement.html#%5CPHPExcel_RichText_ITextElement">\PHPExcel_RichText_ITextElement[]</a> $pElements) : <a href="../classes/PHPExcel_RichText.html">\PHPExcel_RichText</a></pre>
  271. <div class="labels"></div>
  272. <div class="row collapse"><div class="detail-description">
  273. <div class="long_description"></div>
  274. <h3>Parameters</h3>
  275. <div class="subelement argument">
  276. <h4>$pElements</h4>
  277. <code><a href="PHPExcel.RichText.ITextElement.html#%5CPHPExcel_RichText_ITextElement">\PHPExcel_RichText_ITextElement[]</a></code><p>Array of elements</p></div>
  278. <h3>Exceptions</h3>
  279. <table class="table table-bordered"><tr>
  280. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>
  281. <td></td>
  282. </tr></table>
  283. <h3>Returns</h3>
  284. <div class="subelement response"><code><a href="../classes/PHPExcel_RichText.html">\PHPExcel_RichText</a></code></div>
  285. </div></div>
  286. </div>
  287. <h3>
  288. <i class="icon-custom icon-property"></i> Properties</h3>
  289. <a id="property__richTextElements"> </a><div class="element clickable property private property__richTextElements" data-toggle="collapse" data-target=".property__richTextElements .collapse">
  290. <h2></h2>
  291. <pre>$_richTextElements : <a href="PHPExcel.RichText.ITextElement.html#%5CPHPExcel_RichText_ITextElement">\PHPExcel_RichText_ITextElement[]</a></pre>
  292. <div class="labels"></div>
  293. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  294. </div>
  295. </div>
  296. </div>
  297. </div>
  298. </div>
  299. <div class="row"><footer class="span12">
  300. Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
  301. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
  302. generated on 2014-03-02T15:27:36Z.<br></footer></div>
  303. </div>
  304. </body>
  305. </html>