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.

PHPExcel_Comment.html 29 KiB

3 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483
  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_Comment</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_Comment"><span class="description">Create a new PHPExcel_Comment</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_getAlignment" title="getAlignment :: Get Alignment"><span class="description">Get Alignment</span><pre>getAlignment()</pre></a></li>
  99. <li class="method public "><a href="#method_getAuthor" title="getAuthor :: Get Author"><span class="description">Get Author</span><pre>getAuthor()</pre></a></li>
  100. <li class="method public "><a href="#method_getFillColor" title="getFillColor :: Get fill color"><span class="description">Get fill color</span><pre>getFillColor()</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_getHeight" title="getHeight :: Get comment height (CSS style, i.e."><span class="description">Get comment height (CSS style, i.e.</span><pre>getHeight()</pre></a></li>
  103. <li class="method public "><a href="#method_getMarginLeft" title="getMarginLeft :: Get left margin (CSS style, i.e."><span class="description">Get left margin (CSS style, i.e.</span><pre>getMarginLeft()</pre></a></li>
  104. <li class="method public "><a href="#method_getMarginTop" title="getMarginTop :: Get top margin (CSS style, i.e."><span class="description">Get top margin (CSS style, i.e.</span><pre>getMarginTop()</pre></a></li>
  105. <li class="method public "><a href="#method_getText" title="getText :: Get Rich text comment"><span class="description">Get Rich text comment</span><pre>getText()</pre></a></li>
  106. <li class="method public "><a href="#method_getVisible" title="getVisible :: Is the comment visible by default?"><span class="description">Is the comment visible by default?</span><pre>getVisible()</pre></a></li>
  107. <li class="method public "><a href="#method_getWidth" title="getWidth :: Get comment width (CSS style, i.e."><span class="description">Get comment width (CSS style, i.e.</span><pre>getWidth()</pre></a></li>
  108. <li class="method public "><a href="#method_setAlignment" title="setAlignment :: Set Alignment"><span class="description">Set Alignment</span><pre>setAlignment()</pre></a></li>
  109. <li class="method public "><a href="#method_setAuthor" title="setAuthor :: Set Author"><span class="description">Set Author</span><pre>setAuthor()</pre></a></li>
  110. <li class="method public "><a href="#method_setHeight" title="setHeight :: Set comment height (CSS style, i.e."><span class="description">Set comment height (CSS style, i.e.</span><pre>setHeight()</pre></a></li>
  111. <li class="method public "><a href="#method_setMarginLeft" title="setMarginLeft :: Set left margin (CSS style, i.e."><span class="description">Set left margin (CSS style, i.e.</span><pre>setMarginLeft()</pre></a></li>
  112. <li class="method public "><a href="#method_setMarginTop" title="setMarginTop :: Set top margin (CSS style, i.e."><span class="description">Set top margin (CSS style, i.e.</span><pre>setMarginTop()</pre></a></li>
  113. <li class="method public "><a href="#method_setText" title="setText :: Set Rich text comment"><span class="description">Set Rich text comment</span><pre>setText()</pre></a></li>
  114. <li class="method public "><a href="#method_setVisible" title="setVisible :: Set comment default visibility"><span class="description">Set comment default visibility</span><pre>setVisible()</pre></a></li>
  115. <li class="method public "><a href="#method_setWidth" title="setWidth :: Set comment width (CSS style, i.e."><span class="description">Set comment width (CSS style, i.e.</span><pre>setWidth()</pre></a></li>
  116. </ul>
  117. </li>
  118. <li class="nav-header">
  119. <i class="icon-custom icon-property"></i> Properties
  120. <ul></ul>
  121. </li>
  122. <li class="nav-header private">» Private
  123. <ul>
  124. <li class="property private "><a href="#property__alignment" title="$_alignment :: Alignment"><span class="description"></span><pre>$_alignment</pre></a></li>
  125. <li class="property private "><a href="#property__author" title="$_author :: Author"><span class="description"></span><pre>$_author</pre></a></li>
  126. <li class="property private "><a href="#property__fillColor" title="$_fillColor :: Comment fill color"><span class="description"></span><pre>$_fillColor</pre></a></li>
  127. <li class="property private "><a href="#property__height" title="$_height :: Comment height (CSS style, i.e."><span class="description"></span><pre>$_height</pre></a></li>
  128. <li class="property private "><a href="#property__marginLeft" title="$_marginLeft :: Left margin (CSS style, i.e."><span class="description"></span><pre>$_marginLeft</pre></a></li>
  129. <li class="property private "><a href="#property__marginTop" title="$_marginTop :: Top margin (CSS style, i.e."><span class="description"></span><pre>$_marginTop</pre></a></li>
  130. <li class="property private "><a href="#property__text" title="$_text :: Rich text comment"><span class="description"></span><pre>$_text</pre></a></li>
  131. <li class="property private "><a href="#property__visible" title="$_visible :: Visible"><span class="description"></span><pre>$_visible</pre></a></li>
  132. <li class="property private "><a href="#property__width" title="$_width :: Comment width (CSS style, i.e."><span class="description"></span><pre>$_width</pre></a></li>
  133. </ul>
  134. </li>
  135. </ul>
  136. </div>
  137. <div class="span8">
  138. <a id="\PHPExcel_Comment"></a><ul class="breadcrumb">
  139. <li>
  140. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  141. </li>
  142. <li><a href="../namespaces/global.html">global</a></li>
  143. <li class="active">
  144. <span class="divider">\</span><a href="../classes/PHPExcel_Comment.html">PHPExcel_Comment</a>
  145. </li>
  146. </ul>
  147. <div class="element class">
  148. <p class="short_description">PHPExcel_Comment</p>
  149. <div class="details">
  150. <div class="long_description"></div>
  151. <table class="table table-bordered">
  152. <tr>
  153. <th>category</th>
  154. <td>PHPExcel</td>
  155. </tr>
  156. <tr>
  157. <th>package</th>
  158. <td><a href="../packages/PHPExcel.html">PHPExcel</a></td>
  159. </tr>
  160. <tr>
  161. <th>copyright</th>
  162. <td>Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)</td>
  163. </tr>
  164. </table>
  165. <h3>
  166. <i class="icon-custom icon-method"></i> Methods</h3>
  167. <a id="method___clone"></a><div class="element clickable method public method___clone" data-toggle="collapse" data-target=".method___clone .collapse">
  168. <h2>Implement PHP __clone to create a deep clone, not just a shallow copy.</h2>
  169. <pre>__clone() </pre>
  170. <div class="labels"></div>
  171. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  172. </div>
  173. <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
  174. <h2>Create a new PHPExcel_Comment</h2>
  175. <pre>__construct() </pre>
  176. <div class="labels"></div>
  177. <div class="row collapse"><div class="detail-description">
  178. <div class="long_description"></div>
  179. <h3>Exceptions</h3>
  180. <table class="table table-bordered"><tr>
  181. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>
  182. <td></td>
  183. </tr></table>
  184. </div></div>
  185. </div>
  186. <a id="method___toString"></a><div class="element clickable method public method___toString" data-toggle="collapse" data-target=".method___toString .collapse">
  187. <h2>Convert to string</h2>
  188. <pre>__toString() : string</pre>
  189. <div class="labels"></div>
  190. <div class="row collapse"><div class="detail-description">
  191. <div class="long_description"></div>
  192. <h3>Returns</h3>
  193. <div class="subelement response"><code>string</code></div>
  194. </div></div>
  195. </div>
  196. <a id="method_getAlignment"></a><div class="element clickable method public method_getAlignment" data-toggle="collapse" data-target=".method_getAlignment .collapse">
  197. <h2>Get Alignment</h2>
  198. <pre>getAlignment() : string</pre>
  199. <div class="labels"></div>
  200. <div class="row collapse"><div class="detail-description">
  201. <div class="long_description"></div>
  202. <h3>Returns</h3>
  203. <div class="subelement response"><code>string</code></div>
  204. </div></div>
  205. </div>
  206. <a id="method_getAuthor"></a><div class="element clickable method public method_getAuthor" data-toggle="collapse" data-target=".method_getAuthor .collapse">
  207. <h2>Get Author</h2>
  208. <pre>getAuthor() : string</pre>
  209. <div class="labels"></div>
  210. <div class="row collapse"><div class="detail-description">
  211. <div class="long_description"></div>
  212. <h3>Returns</h3>
  213. <div class="subelement response"><code>string</code></div>
  214. </div></div>
  215. </div>
  216. <a id="method_getFillColor"></a><div class="element clickable method public method_getFillColor" data-toggle="collapse" data-target=".method_getFillColor .collapse">
  217. <h2>Get fill color</h2>
  218. <pre>getFillColor() : <a href="../classes/PHPExcel_Style_Color.html">\PHPExcel_Style_Color</a></pre>
  219. <div class="labels"></div>
  220. <div class="row collapse"><div class="detail-description">
  221. <div class="long_description"></div>
  222. <h3>Returns</h3>
  223. <div class="subelement response"><code><a href="../classes/PHPExcel_Style_Color.html">\PHPExcel_Style_Color</a></code></div>
  224. </div></div>
  225. </div>
  226. <a id="method_getHashCode"></a><div class="element clickable method public method_getHashCode" data-toggle="collapse" data-target=".method_getHashCode .collapse">
  227. <h2>Get hash code</h2>
  228. <pre>getHashCode() : string</pre>
  229. <div class="labels"></div>
  230. <div class="row collapse"><div class="detail-description">
  231. <div class="long_description"></div>
  232. <h3>Returns</h3>
  233. <div class="subelement response">
  234. <code>string</code>Hash code</div>
  235. </div></div>
  236. </div>
  237. <a id="method_getHeight"></a><div class="element clickable method public method_getHeight" data-toggle="collapse" data-target=".method_getHeight .collapse">
  238. <h2>Get comment height (CSS style, i.e.</h2>
  239. <pre>getHeight() : string</pre>
  240. <div class="labels"></div>
  241. <div class="row collapse"><div class="detail-description">
  242. <div class="long_description"><p>XXpx or YYpt)</p></div>
  243. <h3>Returns</h3>
  244. <div class="subelement response"><code>string</code></div>
  245. </div></div>
  246. </div>
  247. <a id="method_getMarginLeft"></a><div class="element clickable method public method_getMarginLeft" data-toggle="collapse" data-target=".method_getMarginLeft .collapse">
  248. <h2>Get left margin (CSS style, i.e.</h2>
  249. <pre>getMarginLeft() : string</pre>
  250. <div class="labels"></div>
  251. <div class="row collapse"><div class="detail-description">
  252. <div class="long_description"><p>XXpx or YYpt)</p></div>
  253. <h3>Returns</h3>
  254. <div class="subelement response"><code>string</code></div>
  255. </div></div>
  256. </div>
  257. <a id="method_getMarginTop"></a><div class="element clickable method public method_getMarginTop" data-toggle="collapse" data-target=".method_getMarginTop .collapse">
  258. <h2>Get top margin (CSS style, i.e.</h2>
  259. <pre>getMarginTop() : string</pre>
  260. <div class="labels"></div>
  261. <div class="row collapse"><div class="detail-description">
  262. <div class="long_description"><p>XXpx or YYpt)</p></div>
  263. <h3>Returns</h3>
  264. <div class="subelement response"><code>string</code></div>
  265. </div></div>
  266. </div>
  267. <a id="method_getText"></a><div class="element clickable method public method_getText" data-toggle="collapse" data-target=".method_getText .collapse">
  268. <h2>Get Rich text comment</h2>
  269. <pre>getText() : <a href="../classes/PHPExcel_RichText.html">\PHPExcel_RichText</a></pre>
  270. <div class="labels"></div>
  271. <div class="row collapse"><div class="detail-description">
  272. <div class="long_description"></div>
  273. <h3>Returns</h3>
  274. <div class="subelement response"><code><a href="../classes/PHPExcel_RichText.html">\PHPExcel_RichText</a></code></div>
  275. </div></div>
  276. </div>
  277. <a id="method_getVisible"></a><div class="element clickable method public method_getVisible" data-toggle="collapse" data-target=".method_getVisible .collapse">
  278. <h2>Is the comment visible by default?</h2>
  279. <pre>getVisible() : boolean</pre>
  280. <div class="labels"></div>
  281. <div class="row collapse"><div class="detail-description">
  282. <div class="long_description"></div>
  283. <h3>Returns</h3>
  284. <div class="subelement response"><code>boolean</code></div>
  285. </div></div>
  286. </div>
  287. <a id="method_getWidth"></a><div class="element clickable method public method_getWidth" data-toggle="collapse" data-target=".method_getWidth .collapse">
  288. <h2>Get comment width (CSS style, i.e.</h2>
  289. <pre>getWidth() : string</pre>
  290. <div class="labels"></div>
  291. <div class="row collapse"><div class="detail-description">
  292. <div class="long_description"><p>XXpx or YYpt)</p></div>
  293. <h3>Returns</h3>
  294. <div class="subelement response"><code>string</code></div>
  295. </div></div>
  296. </div>
  297. <a id="method_setAlignment"></a><div class="element clickable method public method_setAlignment" data-toggle="collapse" data-target=".method_setAlignment .collapse">
  298. <h2>Set Alignment</h2>
  299. <pre>setAlignment(string $pValue) : <a href="../classes/PHPExcel_Comment.html">\PHPExcel_Comment</a></pre>
  300. <div class="labels"></div>
  301. <div class="row collapse"><div class="detail-description">
  302. <div class="long_description"></div>
  303. <h3>Parameters</h3>
  304. <div class="subelement argument">
  305. <h4>$pValue</h4>
  306. <code>string</code>
  307. </div>
  308. <h3>Returns</h3>
  309. <div class="subelement response"><code><a href="../classes/PHPExcel_Comment.html">\PHPExcel_Comment</a></code></div>
  310. </div></div>
  311. </div>
  312. <a id="method_setAuthor"></a><div class="element clickable method public method_setAuthor" data-toggle="collapse" data-target=".method_setAuthor .collapse">
  313. <h2>Set Author</h2>
  314. <pre>setAuthor(string $pValue) : <a href="../classes/PHPExcel_Comment.html">\PHPExcel_Comment</a></pre>
  315. <div class="labels"></div>
  316. <div class="row collapse"><div class="detail-description">
  317. <div class="long_description"></div>
  318. <h3>Parameters</h3>
  319. <div class="subelement argument">
  320. <h4>$pValue</h4>
  321. <code>string</code>
  322. </div>
  323. <h3>Returns</h3>
  324. <div class="subelement response"><code><a href="../classes/PHPExcel_Comment.html">\PHPExcel_Comment</a></code></div>
  325. </div></div>
  326. </div>
  327. <a id="method_setHeight"></a><div class="element clickable method public method_setHeight" data-toggle="collapse" data-target=".method_setHeight .collapse">
  328. <h2>Set comment height (CSS style, i.e.</h2>
  329. <pre>setHeight(string $value) : <a href="../classes/PHPExcel_Comment.html">\PHPExcel_Comment</a></pre>
  330. <div class="labels"></div>
  331. <div class="row collapse"><div class="detail-description">
  332. <div class="long_description"><p>XXpx or YYpt)</p></div>
  333. <h3>Parameters</h3>
  334. <div class="subelement argument">
  335. <h4>$value</h4>
  336. <code>string</code>
  337. </div>
  338. <h3>Returns</h3>
  339. <div class="subelement response"><code><a href="../classes/PHPExcel_Comment.html">\PHPExcel_Comment</a></code></div>
  340. </div></div>
  341. </div>
  342. <a id="method_setMarginLeft"></a><div class="element clickable method public method_setMarginLeft" data-toggle="collapse" data-target=".method_setMarginLeft .collapse">
  343. <h2>Set left margin (CSS style, i.e.</h2>
  344. <pre>setMarginLeft(string $value) : <a href="../classes/PHPExcel_Comment.html">\PHPExcel_Comment</a></pre>
  345. <div class="labels"></div>
  346. <div class="row collapse"><div class="detail-description">
  347. <div class="long_description"><p>XXpx or YYpt)</p></div>
  348. <h3>Parameters</h3>
  349. <div class="subelement argument">
  350. <h4>$value</h4>
  351. <code>string</code>
  352. </div>
  353. <h3>Returns</h3>
  354. <div class="subelement response"><code><a href="../classes/PHPExcel_Comment.html">\PHPExcel_Comment</a></code></div>
  355. </div></div>
  356. </div>
  357. <a id="method_setMarginTop"></a><div class="element clickable method public method_setMarginTop" data-toggle="collapse" data-target=".method_setMarginTop .collapse">
  358. <h2>Set top margin (CSS style, i.e.</h2>
  359. <pre>setMarginTop(string $value) : <a href="../classes/PHPExcel_Comment.html">\PHPExcel_Comment</a></pre>
  360. <div class="labels"></div>
  361. <div class="row collapse"><div class="detail-description">
  362. <div class="long_description"><p>XXpx or YYpt)</p></div>
  363. <h3>Parameters</h3>
  364. <div class="subelement argument">
  365. <h4>$value</h4>
  366. <code>string</code>
  367. </div>
  368. <h3>Returns</h3>
  369. <div class="subelement response"><code><a href="../classes/PHPExcel_Comment.html">\PHPExcel_Comment</a></code></div>
  370. </div></div>
  371. </div>
  372. <a id="method_setText"></a><div class="element clickable method public method_setText" data-toggle="collapse" data-target=".method_setText .collapse">
  373. <h2>Set Rich text comment</h2>
  374. <pre>setText(\PHPExcel_RichText $pValue) : <a href="../classes/PHPExcel_Comment.html">\PHPExcel_Comment</a></pre>
  375. <div class="labels"></div>
  376. <div class="row collapse"><div class="detail-description">
  377. <div class="long_description"></div>
  378. <h3>Parameters</h3>
  379. <div class="subelement argument">
  380. <h4>$pValue</h4>
  381. <code><a href="../classes/PHPExcel_RichText.html">\PHPExcel_RichText</a></code>
  382. </div>
  383. <h3>Returns</h3>
  384. <div class="subelement response"><code><a href="../classes/PHPExcel_Comment.html">\PHPExcel_Comment</a></code></div>
  385. </div></div>
  386. </div>
  387. <a id="method_setVisible"></a><div class="element clickable method public method_setVisible" data-toggle="collapse" data-target=".method_setVisible .collapse">
  388. <h2>Set comment default visibility</h2>
  389. <pre>setVisible(boolean $value) : <a href="../classes/PHPExcel_Comment.html">\PHPExcel_Comment</a></pre>
  390. <div class="labels"></div>
  391. <div class="row collapse"><div class="detail-description">
  392. <div class="long_description"></div>
  393. <h3>Parameters</h3>
  394. <div class="subelement argument">
  395. <h4>$value</h4>
  396. <code>boolean</code>
  397. </div>
  398. <h3>Returns</h3>
  399. <div class="subelement response"><code><a href="../classes/PHPExcel_Comment.html">\PHPExcel_Comment</a></code></div>
  400. </div></div>
  401. </div>
  402. <a id="method_setWidth"></a><div class="element clickable method public method_setWidth" data-toggle="collapse" data-target=".method_setWidth .collapse">
  403. <h2>Set comment width (CSS style, i.e.</h2>
  404. <pre>setWidth(string $value) : <a href="../classes/PHPExcel_Comment.html">\PHPExcel_Comment</a></pre>
  405. <div class="labels"></div>
  406. <div class="row collapse"><div class="detail-description">
  407. <div class="long_description"><p>XXpx or YYpt)</p></div>
  408. <h3>Parameters</h3>
  409. <div class="subelement argument">
  410. <h4>$value</h4>
  411. <code>string</code>
  412. </div>
  413. <h3>Returns</h3>
  414. <div class="subelement response"><code><a href="../classes/PHPExcel_Comment.html">\PHPExcel_Comment</a></code></div>
  415. </div></div>
  416. </div>
  417. <h3>
  418. <i class="icon-custom icon-property"></i> Properties</h3>
  419. <a id="property__alignment"> </a><div class="element clickable property private property__alignment" data-toggle="collapse" data-target=".property__alignment .collapse">
  420. <h2></h2>
  421. <pre>$_alignment : string</pre>
  422. <div class="labels"></div>
  423. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  424. </div>
  425. <a id="property__author"> </a><div class="element clickable property private property__author" data-toggle="collapse" data-target=".property__author .collapse">
  426. <h2></h2>
  427. <pre>$_author : string</pre>
  428. <div class="labels"></div>
  429. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  430. </div>
  431. <a id="property__fillColor"> </a><div class="element clickable property private property__fillColor" data-toggle="collapse" data-target=".property__fillColor .collapse">
  432. <h2></h2>
  433. <pre>$_fillColor : <a href="../classes/PHPExcel_Style_Color.html">\PHPExcel_Style_Color</a></pre>
  434. <div class="labels"></div>
  435. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  436. </div>
  437. <a id="property__height"> </a><div class="element clickable property private property__height" data-toggle="collapse" data-target=".property__height .collapse">
  438. <h2></h2>
  439. <pre>$_height : string</pre>
  440. <div class="labels"></div>
  441. <div class="row collapse"><div class="detail-description"><div class="long_description"><p>XXpx or YYpt)</p></div></div></div>
  442. </div>
  443. <a id="property__marginLeft"> </a><div class="element clickable property private property__marginLeft" data-toggle="collapse" data-target=".property__marginLeft .collapse">
  444. <h2></h2>
  445. <pre>$_marginLeft : string</pre>
  446. <div class="labels"></div>
  447. <div class="row collapse"><div class="detail-description"><div class="long_description"><p>XXpx or YYpt)</p></div></div></div>
  448. </div>
  449. <a id="property__marginTop"> </a><div class="element clickable property private property__marginTop" data-toggle="collapse" data-target=".property__marginTop .collapse">
  450. <h2></h2>
  451. <pre>$_marginTop : string</pre>
  452. <div class="labels"></div>
  453. <div class="row collapse"><div class="detail-description"><div class="long_description"><p>XXpx or YYpt)</p></div></div></div>
  454. </div>
  455. <a id="property__text"> </a><div class="element clickable property private property__text" data-toggle="collapse" data-target=".property__text .collapse">
  456. <h2></h2>
  457. <pre>$_text : <a href="../classes/PHPExcel_RichText.html">\PHPExcel_RichText</a></pre>
  458. <div class="labels"></div>
  459. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  460. </div>
  461. <a id="property__visible"> </a><div class="element clickable property private property__visible" data-toggle="collapse" data-target=".property__visible .collapse">
  462. <h2></h2>
  463. <pre>$_visible : boolean</pre>
  464. <div class="labels"></div>
  465. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  466. </div>
  467. <a id="property__width"> </a><div class="element clickable property private property__width" data-toggle="collapse" data-target=".property__width .collapse">
  468. <h2></h2>
  469. <pre>$_width : string</pre>
  470. <div class="labels"></div>
  471. <div class="row collapse"><div class="detail-description"><div class="long_description"><p>XXpx or YYpt)</p></div></div></div>
  472. </div>
  473. </div>
  474. </div>
  475. </div>
  476. </div>
  477. <div class="row"><footer class="span12">
  478. 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>
  479. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
  480. generated on 2014-03-02T15:27:35Z.<br></footer></div>
  481. </div>
  482. </body>
  483. </html>