nizongfeng
/
zzcx_line
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
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.
2 Commits
1 Branch
17 MiB
 
 
 
 
Tree: aa52171df8
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'aa52171df8'
${ noResults }
zzcx_line/coding/st-xm/ORG/Documentation/API/classes/PHPExcel_Cell.html

968 lines
56 KiB
Raw Blame History 

  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_Cell</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 Cell"><span class="description">Create a new Cell</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_absoluteCoordinate" title="absoluteCoordinate :: Make string coordinate absolute"><span class="description">Make string coordinate absolute</span><pre>absoluteCoordinate()</pre></a></li>

  99. <li class="method public "><a href="#method_absoluteReference" title="absoluteReference :: Make string row, column or cell coordinate absolute"><span class="description">Make string row, column or cell coordinate absolute</span><pre>absoluteReference()</pre></a></li>

  100. <li class="method public "><a href="#method_attach" title="attach :: "><span class="description">attach()

  101.         </span><pre>attach()</pre></a></li>

  102. <li class="method public "><a href="#method_buildRange" title="buildRange :: Build range from coordinate strings"><span class="description">Build range from coordinate strings</span><pre>buildRange()</pre></a></li>

  103. <li class="method public "><a href="#method_columnIndexFromString" title="columnIndexFromString :: Column index from string"><span class="description">Column index from string</span><pre>columnIndexFromString()</pre></a></li>

  104. <li class="method public "><a href="#method_compareCells" title="compareCells :: Compare 2 cells"><span class="description">Compare 2 cells</span><pre>compareCells()</pre></a></li>

  105. <li class="method public "><a href="#method_coordinateFromString" title="coordinateFromString :: Coordinate from string"><span class="description">Coordinate from string</span><pre>coordinateFromString()</pre></a></li>

  106. <li class="method public "><a href="#method_detach" title="detach :: "><span class="description">detach()

  107.         </span><pre>detach()</pre></a></li>

  108. <li class="method public "><a href="#method_extractAllCellReferencesInRange" title="extractAllCellReferencesInRange :: Extract all cell references in range"><span class="description">Extract all cell references in range</span><pre>extractAllCellReferencesInRange()</pre></a></li>

  109. <li class="method public "><a href="#method_getCalculatedValue" title="getCalculatedValue :: Get calculated cell value"><span class="description">Get calculated cell value</span><pre>getCalculatedValue()</pre></a></li>

  110. <li class="method public "><a href="#method_getColumn" title="getColumn :: Get cell coordinate column"><span class="description">Get cell coordinate column</span><pre>getColumn()</pre></a></li>

  111. <li class="method public "><a href="#method_getCoordinate" title="getCoordinate :: Get cell coordinate"><span class="description">Get cell coordinate</span><pre>getCoordinate()</pre></a></li>

  112. <li class="method public "><a href="#method_getDataType" title="getDataType :: Get cell data type"><span class="description">Get cell data type</span><pre>getDataType()</pre></a></li>

  113. <li class="method public "><a href="#method_getDataValidation" title="getDataValidation :: Get Data validation rules"><span class="description">Get Data validation rules</span><pre>getDataValidation()</pre></a></li>

  114. <li class="method public "><a href="#method_getFormattedValue" title="getFormattedValue :: Get cell value with formatting"><span class="description">Get cell value with formatting</span><pre>getFormattedValue()</pre></a></li>

  115. <li class="method public "><a href="#method_getFormulaAttributes" title="getFormulaAttributes :: "><span class="description">getFormulaAttributes()

  116.         </span><pre>getFormulaAttributes()</pre></a></li>

  117. <li class="method public "><a href="#method_getHyperlink" title="getHyperlink :: Get Hyperlink"><span class="description">Get Hyperlink</span><pre>getHyperlink()</pre></a></li>

  118. <li class="method public "><a href="#method_getOldCalculatedValue" title="getOldCalculatedValue :: Get old calculated value (cached)

  119. This returns the value last calculated by MS Excel or whichever spreadsheet program was used to

  120. 	create the original spreadsheet file."><span class="description">Get old calculated value (cached)

  121. This returns the value last calculated by MS Excel or whichever spreadsheet program was used to

  122. 	create the original spreadsheet file.</span><pre>getOldCalculatedValue()</pre></a></li>

  123. <li class="method public "><a href="#method_getParent" title="getParent :: Get parent worksheet"><span class="description">Get parent worksheet</span><pre>getParent()</pre></a></li>

  124. <li class="method public "><a href="#method_getRangeBoundaries" title="getRangeBoundaries :: Calculate range boundaries"><span class="description">Calculate range boundaries</span><pre>getRangeBoundaries()</pre></a></li>

  125. <li class="method public "><a href="#method_getRow" title="getRow :: Get cell coordinate row"><span class="description">Get cell coordinate row</span><pre>getRow()</pre></a></li>

  126. <li class="method public "><a href="#method_getStyle" title="getStyle :: Get cell style"><span class="description">Get cell style</span><pre>getStyle()</pre></a></li>

  127. <li class="method public "><a href="#method_getValue" title="getValue :: Get cell value"><span class="description">Get cell value</span><pre>getValue()</pre></a></li>

  128. <li class="method public "><a href="#method_getValueBinder" title="getValueBinder :: Get value binder to use"><span class="description">Get value binder to use</span><pre>getValueBinder()</pre></a></li>

  129. <li class="method public "><a href="#method_getWorksheet" title="getWorksheet :: Get parent worksheet"><span class="description">Get parent worksheet</span><pre>getWorksheet()</pre></a></li>

  130. <li class="method public "><a href="#method_getXfIndex" title="getXfIndex :: Get index to cellXf"><span class="description">Get index to cellXf</span><pre>getXfIndex()</pre></a></li>

  131. <li class="method public "><a href="#method_hasDataValidation" title="hasDataValidation :: Does this cell contain Data validation rules?"><span class="description">Does this cell contain Data validation rules?</span><pre>hasDataValidation()</pre></a></li>

  132. <li class="method public "><a href="#method_hasHyperlink" title="hasHyperlink :: Does this cell contain a Hyperlink?"><span class="description">Does this cell contain a Hyperlink?</span><pre>hasHyperlink()</pre></a></li>

  133. <li class="method public "><a href="#method_isFormula" title="isFormula :: Identify if the cell contains a formula"><span class="description">Identify if the cell contains a formula</span><pre>isFormula()</pre></a></li>

  134. <li class="method public "><a href="#method_isInRange" title="isInRange :: Is cell in a specific range?"><span class="description">Is cell in a specific range?</span><pre>isInRange()</pre></a></li>

  135. <li class="method public "><a href="#method_notifyCacheController" title="notifyCacheController :: Send notification to the cache controller"><span class="description">Send notification to the cache controller</span><pre>notifyCacheController()</pre></a></li>

  136. <li class="method public "><a href="#method_rangeBoundaries" title="rangeBoundaries :: Calculate range boundaries"><span class="description">Calculate range boundaries</span><pre>rangeBoundaries()</pre></a></li>

  137. <li class="method public "><a href="#method_rangeDimension" title="rangeDimension :: Calculate range dimension"><span class="description">Calculate range dimension</span><pre>rangeDimension()</pre></a></li>

  138. <li class="method public "><a href="#method_rebindParent" title="rebindParent :: Re-bind parent"><span class="description">Re-bind parent</span><pre>rebindParent()</pre></a></li>

  139. <li class="method public "><a href="#method_setCalculatedValue" title="setCalculatedValue :: Set old calculated value (cached)"><span class="description">Set old calculated value (cached)</span><pre>setCalculatedValue()</pre></a></li>

  140. <li class="method public "><a href="#method_setDataType" title="setDataType :: Set cell data type"><span class="description">Set cell data type</span><pre>setDataType()</pre></a></li>

  141. <li class="method public "><a href="#method_setDataValidation" title="setDataValidation :: Set Data validation rules"><span class="description">Set Data validation rules</span><pre>setDataValidation()</pre></a></li>

  142. <li class="method public "><a href="#method_setFormulaAttributes" title="setFormulaAttributes :: "><span class="description">setFormulaAttributes()

  143.         </span><pre>setFormulaAttributes()</pre></a></li>

  144. <li class="method public "><a href="#method_setHyperlink" title="setHyperlink :: Set Hyperlink"><span class="description">Set Hyperlink</span><pre>setHyperlink()</pre></a></li>

  145. <li class="method public "><a href="#method_setValue" title="setValue :: Set cell value"><span class="description">Set cell value</span><pre>setValue()</pre></a></li>

  146. <li class="method public "><a href="#method_setValueBinder" title="setValueBinder :: Set value binder to use"><span class="description">Set value binder to use</span><pre>setValueBinder()</pre></a></li>

  147. <li class="method public "><a href="#method_setValueExplicit" title="setValueExplicit :: Set the value for a cell, with the explicit data type passed to the method (bypassing any use of the value binder)"><span class="description">Set the value for a cell, with the explicit data type passed to the method (bypassing any use of the value binder)</span><pre>setValueExplicit()</pre></a></li>

  148. <li class="method public "><a href="#method_setXfIndex" title="setXfIndex :: Set index to cellXf"><span class="description">Set index to cellXf</span><pre>setXfIndex()</pre></a></li>

  149. <li class="method public "><a href="#method_splitRange" title="splitRange :: Split range into coordinate strings"><span class="description">Split range into coordinate strings</span><pre>splitRange()</pre></a></li>

  150. <li class="method public "><a href="#method_stringFromColumnIndex" title="stringFromColumnIndex :: String from columnindex"><span class="description">String from columnindex</span><pre>stringFromColumnIndex()</pre></a></li>

  151. </ul>

  152. </li>

  153. <li class="nav-header">

  154. <i class="icon-custom icon-property"></i> Properties

  155.                     <ul></ul>

  156. </li>

  157. <li class="nav-header private">» Private

  158.                     <ul>

  159. <li class="property private "><a href="#property__calculatedValue" title="$_calculatedValue :: Calculated value of the cell (used for caching)

  160. This returns the value last calculated by MS Excel or whichever spreadsheet program was used to

  161. 	create the original spreadsheet file."><span class="description"></span><pre>$_calculatedValue</pre></a></li>

  162. <li class="property private "><a href="#property__dataType" title="$_dataType :: Type of the cell data"><span class="description"></span><pre>$_dataType</pre></a></li>

  163. <li class="property private "><a href="#property__formulaAttributes" title="$_formulaAttributes :: Attributes of the formula"><span class="description"></span><pre>$_formulaAttributes</pre></a></li>

  164. <li class="property private "><a href="#property__parent" title="$_parent :: Parent worksheet"><span class="description"></span><pre>$_parent</pre></a></li>

  165. <li class="property private "><a href="#property__value" title="$_value :: Value of the cell"><span class="description"></span><pre>$_value</pre></a></li>

  166. <li class="property private "><a href="#property__valueBinder" title="$_valueBinder :: Value binder to use"><span class="description"></span><pre>$_valueBinder</pre></a></li>

  167. <li class="property private "><a href="#property__xfIndex" title="$_xfIndex :: Index to cellXf"><span class="description"></span><pre>$_xfIndex</pre></a></li>

  168. </ul>

  169. </li>

  170. <li class="nav-header">

  171. <i class="icon-custom icon-constant"></i> Constants

  172.                     <ul><li class="constant  "><a href="#constant_DEFAULT_RANGE" title="DEFAULT_RANGE :: Default range variable constant"><span class="description">Default range variable constant</span><pre>DEFAULT_RANGE</pre></a></li></ul>

  173. </li>

  174. </ul>

  175. </div>

  176. <div class="span8">

  177. <a id="\PHPExcel_Cell"></a><ul class="breadcrumb">

  178. <li>

  179. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>

  180. </li>

  181. <li><a href="../namespaces/global.html">global</a></li>

  182. <li class="active">

  183. <span class="divider">\</span><a href="../classes/PHPExcel_Cell.html">PHPExcel_Cell</a>

  184. </li>

  185. </ul>

  186. <div class="element class">

  187. <p class="short_description">PHPExcel_Cell</p>

  188. <div class="details">

  189. <div class="long_description"></div>

  190. <table class="table table-bordered">

  191. <tr>

  192. <th>category</th>

  193. <td>PHPExcel</td>

  194. </tr>

  195. <tr>

  196. <th>package</th>

  197. <td><a href="../packages/PHPExcel.Cell.html">PHPExcel_Cell</a></td>

  198. </tr>

  199. <tr>

  200. <th>copyright</th>

  201. <td>Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)</td>

  202. </tr>

  203. </table>

  204. <h3>

  205. <i class="icon-custom icon-method"></i> Methods</h3>

  206. <a id="method___clone"></a><div class="element clickable method public method___clone" data-toggle="collapse" data-target=".method___clone .collapse">

  207. <h2>Implement PHP __clone to create a deep clone, not just a shallow copy.</h2>

  208. <pre>__clone() </pre>

  209. <div class="labels"></div>

  210. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  211. </div>

  212. <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">

  213. <h2>Create a new Cell</h2>

  214. <pre>__construct(mixed $pValue, string $pDataType, \PHPExcel_Worksheet $pSheet) </pre>

  215. <div class="labels"></div>

  216. <div class="row collapse"><div class="detail-description">

  217. <div class="long_description"></div>

  218. <h3>Parameters</h3>

  219. <div class="subelement argument">

  220. <h4>$pValue</h4>

  221. <code>mixed</code>

  222. </div>

  223. <div class="subelement argument">

  224. <h4>$pDataType</h4>

  225. <code>string</code>

  226. </div>

  227. <div class="subelement argument">

  228. <h4>$pSheet</h4>

  229. <code><a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></code>

  230. </div>

  231. <h3>Exceptions</h3>

  232. <table class="table table-bordered"><tr>

  233. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>

  234. <td></td>

  235. </tr></table>

  236. </div></div>

  237. </div>

  238. <a id="method___toString"></a><div class="element clickable method public method___toString" data-toggle="collapse" data-target=".method___toString .collapse">

  239. <h2>Convert to string</h2>

  240. <pre>__toString() : string</pre>

  241. <div class="labels"></div>

  242. <div class="row collapse"><div class="detail-description">

  243. <div class="long_description"></div>

  244. <h3>Returns</h3>

  245. <div class="subelement response"><code>string</code></div>

  246. </div></div>

  247. </div>

  248. <a id="method_absoluteCoordinate"></a><div class="element clickable method public method_absoluteCoordinate" data-toggle="collapse" data-target=".method_absoluteCoordinate .collapse">

  249. <h2>Make string coordinate absolute</h2>

  250. <pre>absoluteCoordinate(string $pCoordinateString) : string</pre>

  251. <div class="labels"><span class="label">Static</span></div>

  252. <div class="row collapse"><div class="detail-description">

  253. <div class="long_description"></div>

  254. <h3>Parameters</h3>

  255. <div class="subelement argument">

  256. <h4>$pCoordinateString</h4>

  257. <code>string</code><p>e.g. 'A1'</p>

  258. </div>

  259. <h3>Exceptions</h3>

  260. <table class="table table-bordered"><tr>

  261. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>

  262. <td></td>

  263. </tr></table>

  264. <h3>Returns</h3>

  265. <div class="subelement response">

  266. <code>string</code>Absolute coordinate		e.g. '$A$1'</div>

  267. </div></div>

  268. </div>

  269. <a id="method_absoluteReference"></a><div class="element clickable method public method_absoluteReference" data-toggle="collapse" data-target=".method_absoluteReference .collapse">

  270. <h2>Make string row, column or cell coordinate absolute</h2>

  271. <pre>absoluteReference(string $pCoordinateString) : string</pre>

  272. <div class="labels"><span class="label">Static</span></div>

  273. <div class="row collapse"><div class="detail-description">

  274. <div class="long_description"></div>

  275. <h3>Parameters</h3>

  276. <div class="subelement argument">

  277. <h4>$pCoordinateString</h4>

  278. <code>string</code><p>e.g. 'A' or '1' or 'A1'

  279.                 Note that this value can be a row or column reference as well as a cell reference</p>

  280. </div>

  281. <h3>Exceptions</h3>

  282. <table class="table table-bordered"><tr>

  283. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>

  284. <td></td>

  285. </tr></table>

  286. <h3>Returns</h3>

  287. <div class="subelement response">

  288. <code>string</code>Absolute coordinate		e.g. '$A' or '$1' or '$A$1'</div>

  289. </div></div>

  290. </div>

  291. <a id="method_attach"></a><div class="element clickable method public method_attach" data-toggle="collapse" data-target=".method_attach .collapse">

  292. <h2>attach()

  293.         </h2>

  294. <pre>attach(\PHPExcel_CachedObjectStorage_CacheBase $parent) </pre>

  295. <div class="labels"></div>

  296. <div class="row collapse"><div class="detail-description">

  297. <div class="long_description"></div>

  298. <h3>Parameters</h3>

  299. <div class="subelement argument"><h4>$parent</h4></div>

  300. </div></div>

  301. </div>

  302. <a id="method_buildRange"></a><div class="element clickable method public method_buildRange" data-toggle="collapse" data-target=".method_buildRange .collapse">

  303. <h2>Build range from coordinate strings</h2>

  304. <pre>buildRange(array $pRange) : string</pre>

  305. <div class="labels"><span class="label">Static</span></div>

  306. <div class="row collapse"><div class="detail-description">

  307. <div class="long_description"></div>

  308. <h3>Parameters</h3>

  309. <div class="subelement argument">

  310. <h4>$pRange</h4>

  311. <code>array</code><p>Array containg one or more arrays containing one or two coordinate strings</p></div>

  312. <h3>Exceptions</h3>

  313. <table class="table table-bordered"><tr>

  314. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>

  315. <td></td>

  316. </tr></table>

  317. <h3>Returns</h3>

  318. <div class="subelement response">

  319. <code>string</code>String representation of $pRange</div>

  320. </div></div>

  321. </div>

  322. <a id="method_columnIndexFromString"></a><div class="element clickable method public method_columnIndexFromString" data-toggle="collapse" data-target=".method_columnIndexFromString .collapse">

  323. <h2>Column index from string</h2>

  324. <pre>columnIndexFromString(string $pString) : int</pre>

  325. <div class="labels"><span class="label">Static</span></div>

  326. <div class="row collapse"><div class="detail-description">

  327. <div class="long_description"></div>

  328. <h3>Parameters</h3>

  329. <div class="subelement argument">

  330. <h4>$pString</h4>

  331. <code>string</code>

  332. </div>

  333. <h3>Returns</h3>

  334. <div class="subelement response">

  335. <code>int</code>Column index (base 1 !!!)</div>

  336. </div></div>

  337. </div>

  338. <a id="method_compareCells"></a><div class="element clickable method public method_compareCells" data-toggle="collapse" data-target=".method_compareCells .collapse">

  339. <h2>Compare 2 cells</h2>

  340. <pre>compareCells(\PHPExcel_Cell $a, \PHPExcel_Cell $b) : int</pre>

  341. <div class="labels"><span class="label">Static</span></div>

  342. <div class="row collapse"><div class="detail-description">

  343. <div class="long_description"></div>

  344. <h3>Parameters</h3>

  345. <div class="subelement argument">

  346. <h4>$a</h4>

  347. <code><a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></code><p>Cell a</p></div>

  348. <div class="subelement argument">

  349. <h4>$b</h4>

  350. <code><a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></code><p>Cell b</p></div>

  351. <h3>Returns</h3>

  352. <div class="subelement response">

  353. <code>int</code>Result of comparison (always -1 or 1, never zero!)</div>

  354. </div></div>

  355. </div>

  356. <a id="method_coordinateFromString"></a><div class="element clickable method public method_coordinateFromString" data-toggle="collapse" data-target=".method_coordinateFromString .collapse">

  357. <h2>Coordinate from string</h2>

  358. <pre>coordinateFromString(string $pCoordinateString) : array</pre>

  359. <div class="labels"><span class="label">Static</span></div>

  360. <div class="row collapse"><div class="detail-description">

  361. <div class="long_description"></div>

  362. <h3>Parameters</h3>

  363. <div class="subelement argument">

  364. <h4>$pCoordinateString</h4>

  365. <code>string</code>

  366. </div>

  367. <h3>Exceptions</h3>

  368. <table class="table table-bordered"><tr>

  369. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>

  370. <td></td>

  371. </tr></table>

  372. <h3>Returns</h3>

  373. <div class="subelement response">

  374. <code>array</code>Array containing column and row (indexes 0 and 1)</div>

  375. </div></div>

  376. </div>

  377. <a id="method_detach"></a><div class="element clickable method public method_detach" data-toggle="collapse" data-target=".method_detach .collapse">

  378. <h2>detach()

  379.         </h2>

  380. <pre>detach() </pre>

  381. <div class="labels"></div>

  382. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  383. </div>

  384. <a id="method_extractAllCellReferencesInRange"></a><div class="element clickable method public method_extractAllCellReferencesInRange" data-toggle="collapse" data-target=".method_extractAllCellReferencesInRange .collapse">

  385. <h2>Extract all cell references in range</h2>

  386. <pre>extractAllCellReferencesInRange(string $pRange) : array</pre>

  387. <div class="labels"><span class="label">Static</span></div>

  388. <div class="row collapse"><div class="detail-description">

  389. <div class="long_description"></div>

  390. <h3>Parameters</h3>

  391. <div class="subelement argument">

  392. <h4>$pRange</h4>

  393. <code>string</code><p>Range (e.g. A1 or A1:C10 or A1:E10 A20:E25)</p>

  394. </div>

  395. <h3>Returns</h3>

  396. <div class="subelement response">

  397. <code>array</code>Array containing single cell references</div>

  398. </div></div>

  399. </div>

  400. <a id="method_getCalculatedValue"></a><div class="element clickable method public method_getCalculatedValue" data-toggle="collapse" data-target=".method_getCalculatedValue .collapse">

  401. <h2>Get calculated cell value</h2>

  402. <pre>getCalculatedValue(boolean $resetLog) : mixed</pre>

  403. <div class="labels"></div>

  404. <div class="row collapse"><div class="detail-description">

  405. <div class="long_description"></div>

  406. <table class="table table-bordered"><tr>

  407. <th>deprecated</th>

  408. <td>Since version 1.7.8 for planned changes to cell for array formula handling</td>

  409. </tr></table>

  410. <h3>Parameters</h3>

  411. <div class="subelement argument">

  412. <h4>$resetLog</h4>

  413. <code>boolean</code><p>Whether the calculation engine logger should be reset or not</p></div>

  414. <h3>Exceptions</h3>

  415. <table class="table table-bordered"><tr>

  416. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>

  417. <td></td>

  418. </tr></table>

  419. <h3>Returns</h3>

  420. <div class="subelement response"><code>mixed</code></div>

  421. </div></div>

  422. </div>

  423. <a id="method_getColumn"></a><div class="element clickable method public method_getColumn" data-toggle="collapse" data-target=".method_getColumn .collapse">

  424. <h2>Get cell coordinate column</h2>

  425. <pre>getColumn() : string</pre>

  426. <div class="labels"></div>

  427. <div class="row collapse"><div class="detail-description">

  428. <div class="long_description"></div>

  429. <h3>Returns</h3>

  430. <div class="subelement response"><code>string</code></div>

  431. </div></div>

  432. </div>

  433. <a id="method_getCoordinate"></a><div class="element clickable method public method_getCoordinate" data-toggle="collapse" data-target=".method_getCoordinate .collapse">

  434. <h2>Get cell coordinate</h2>

  435. <pre>getCoordinate() : string</pre>

  436. <div class="labels"></div>

  437. <div class="row collapse"><div class="detail-description">

  438. <div class="long_description"></div>

  439. <h3>Returns</h3>

  440. <div class="subelement response"><code>string</code></div>

  441. </div></div>

  442. </div>

  443. <a id="method_getDataType"></a><div class="element clickable method public method_getDataType" data-toggle="collapse" data-target=".method_getDataType .collapse">

  444. <h2>Get cell data type</h2>

  445. <pre>getDataType() : string</pre>

  446. <div class="labels"></div>

  447. <div class="row collapse"><div class="detail-description">

  448. <div class="long_description"></div>

  449. <h3>Returns</h3>

  450. <div class="subelement response"><code>string</code></div>

  451. </div></div>

  452. </div>

  453. <a id="method_getDataValidation"></a><div class="element clickable method public method_getDataValidation" data-toggle="collapse" data-target=".method_getDataValidation .collapse">

  454. <h2>Get Data validation rules</h2>

  455. <pre>getDataValidation() : <a href="../classes/PHPExcel_Cell_DataValidation.html">\PHPExcel_Cell_DataValidation</a></pre>

  456. <div class="labels"></div>

  457. <div class="row collapse"><div class="detail-description">

  458. <div class="long_description"></div>

  459. <h3>Exceptions</h3>

  460. <table class="table table-bordered"><tr>

  461. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>

  462. <td></td>

  463. </tr></table>

  464. <h3>Returns</h3>

  465. <div class="subelement response"><code><a href="../classes/PHPExcel_Cell_DataValidation.html">\PHPExcel_Cell_DataValidation</a></code></div>

  466. </div></div>

  467. </div>

  468. <a id="method_getFormattedValue"></a><div class="element clickable method public method_getFormattedValue" data-toggle="collapse" data-target=".method_getFormattedValue .collapse">

  469. <h2>Get cell value with formatting</h2>

  470. <pre>getFormattedValue() : string</pre>

  471. <div class="labels"></div>

  472. <div class="row collapse"><div class="detail-description">

  473. <div class="long_description"></div>

  474. <h3>Returns</h3>

  475. <div class="subelement response"><code>string</code></div>

  476. </div></div>

  477. </div>

  478. <a id="method_getFormulaAttributes"></a><div class="element clickable method public method_getFormulaAttributes" data-toggle="collapse" data-target=".method_getFormulaAttributes .collapse">

  479. <h2>getFormulaAttributes()

  480.         </h2>

  481. <pre>getFormulaAttributes() </pre>

  482. <div class="labels"></div>

  483. <div class="row collapse"><div class="detail-description">

  484. <div class="long_description"></div>

  485. <table class="table table-bordered"><tr>

  486. <th>deprecated</th>

  487. <td>Since version 1.7.8 for planned changes to cell for array formula handling</td>

  488. </tr></table>

  489. </div></div>

  490. </div>

  491. <a id="method_getHyperlink"></a><div class="element clickable method public method_getHyperlink" data-toggle="collapse" data-target=".method_getHyperlink .collapse">

  492. <h2>Get Hyperlink</h2>

  493. <pre>getHyperlink() : <a href="../classes/PHPExcel_Cell_Hyperlink.html">\PHPExcel_Cell_Hyperlink</a></pre>

  494. <div class="labels"></div>

  495. <div class="row collapse"><div class="detail-description">

  496. <div class="long_description"></div>

  497. <h3>Exceptions</h3>

  498. <table class="table table-bordered"><tr>

  499. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>

  500. <td></td>

  501. </tr></table>

  502. <h3>Returns</h3>

  503. <div class="subelement response"><code><a href="../classes/PHPExcel_Cell_Hyperlink.html">\PHPExcel_Cell_Hyperlink</a></code></div>

  504. </div></div>

  505. </div>

  506. <a id="method_getOldCalculatedValue"></a><div class="element clickable method public method_getOldCalculatedValue" data-toggle="collapse" data-target=".method_getOldCalculatedValue .collapse">

  507. <h2>Get old calculated value (cached)

  508. This returns the value last calculated by MS Excel or whichever spreadsheet program was used to

  509. 	create the original spreadsheet file.</h2>

  510. <pre>getOldCalculatedValue() : mixed</pre>

  511. <div class="labels"></div>

  512. <div class="row collapse"><div class="detail-description">

  513. <div class="long_description"><p>Note that this value is not guaranteed to refelect the actual calculated value because it is

  514.     possible that auto-calculation was disabled in the original spreadsheet, and underlying data

  515.     values used by the formula have changed since it was last calculated.</p></div>

  516. <h3>Returns</h3>

  517. <div class="subelement response"><code>mixed</code></div>

  518. </div></div>

  519. </div>

  520. <a id="method_getParent"></a><div class="element clickable method public method_getParent" data-toggle="collapse" data-target=".method_getParent .collapse">

  521. <h2>Get parent worksheet</h2>

  522. <pre>getParent() : <a href="../classes/PHPExcel_CachedObjectStorage_CacheBase.html">\PHPExcel_CachedObjectStorage_CacheBase</a></pre>

  523. <div class="labels"></div>

  524. <div class="row collapse"><div class="detail-description">

  525. <div class="long_description"></div>

  526. <h3>Returns</h3>

  527. <div class="subelement response"><code><a href="../classes/PHPExcel_CachedObjectStorage_CacheBase.html">\PHPExcel_CachedObjectStorage_CacheBase</a></code></div>

  528. </div></div>

  529. </div>

  530. <a id="method_getRangeBoundaries"></a><div class="element clickable method public method_getRangeBoundaries" data-toggle="collapse" data-target=".method_getRangeBoundaries .collapse">

  531. <h2>Calculate range boundaries</h2>

  532. <pre>getRangeBoundaries(string $pRange) : array</pre>

  533. <div class="labels"><span class="label">Static</span></div>

  534. <div class="row collapse"><div class="detail-description">

  535. <div class="long_description"></div>

  536. <h3>Parameters</h3>

  537. <div class="subelement argument">

  538. <h4>$pRange</h4>

  539. <code>string</code><p>Cell range (e.g. A1:A1)</p>

  540. </div>

  541. <h3>Returns</h3>

  542. <div class="subelement response">

  543. <code>array</code>Range coordinates array(Start Cell, End Cell)

  544. 				where Start Cell and End Cell are arrays (Column ID, Row Number)</div>

  545. </div></div>

  546. </div>

  547. <a id="method_getRow"></a><div class="element clickable method public method_getRow" data-toggle="collapse" data-target=".method_getRow .collapse">

  548. <h2>Get cell coordinate row</h2>

  549. <pre>getRow() : int</pre>

  550. <div class="labels"></div>

  551. <div class="row collapse"><div class="detail-description">

  552. <div class="long_description"></div>

  553. <h3>Returns</h3>

  554. <div class="subelement response"><code>int</code></div>

  555. </div></div>

  556. </div>

  557. <a id="method_getStyle"></a><div class="element clickable method public method_getStyle" data-toggle="collapse" data-target=".method_getStyle .collapse">

  558. <h2>Get cell style</h2>

  559. <pre>getStyle() : <a href="../classes/PHPExcel_Style.html">\PHPExcel_Style</a></pre>

  560. <div class="labels"></div>

  561. <div class="row collapse"><div class="detail-description">

  562. <div class="long_description"></div>

  563. <h3>Returns</h3>

  564. <div class="subelement response"><code><a href="../classes/PHPExcel_Style.html">\PHPExcel_Style</a></code></div>

  565. </div></div>

  566. </div>

  567. <a id="method_getValue"></a><div class="element clickable method public method_getValue" data-toggle="collapse" data-target=".method_getValue .collapse">

  568. <h2>Get cell value</h2>

  569. <pre>getValue() : mixed</pre>

  570. <div class="labels"></div>

  571. <div class="row collapse"><div class="detail-description">

  572. <div class="long_description"></div>

  573. <h3>Returns</h3>

  574. <div class="subelement response"><code>mixed</code></div>

  575. </div></div>

  576. </div>

  577. <a id="method_getValueBinder"></a><div class="element clickable method public method_getValueBinder" data-toggle="collapse" data-target=".method_getValueBinder .collapse">

  578. <h2>Get value binder to use</h2>

  579. <pre>getValueBinder() : <a href="../classes/PHPExcel_Cell_IValueBinder.html">\PHPExcel_Cell_IValueBinder</a></pre>

  580. <div class="labels"><span class="label">Static</span></div>

  581. <div class="row collapse"><div class="detail-description">

  582. <div class="long_description"></div>

  583. <h3>Returns</h3>

  584. <div class="subelement response"><code><a href="../classes/PHPExcel_Cell_IValueBinder.html">\PHPExcel_Cell_IValueBinder</a></code></div>

  585. </div></div>

  586. </div>

  587. <a id="method_getWorksheet"></a><div class="element clickable method public method_getWorksheet" data-toggle="collapse" data-target=".method_getWorksheet .collapse">

  588. <h2>Get parent worksheet</h2>

  589. <pre>getWorksheet() : <a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></pre>

  590. <div class="labels"></div>

  591. <div class="row collapse"><div class="detail-description">

  592. <div class="long_description"></div>

  593. <h3>Returns</h3>

  594. <div class="subelement response"><code><a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></code></div>

  595. </div></div>

  596. </div>

  597. <a id="method_getXfIndex"></a><div class="element clickable method public method_getXfIndex" data-toggle="collapse" data-target=".method_getXfIndex .collapse">

  598. <h2>Get index to cellXf</h2>

  599. <pre>getXfIndex() : int</pre>

  600. <div class="labels"></div>

  601. <div class="row collapse"><div class="detail-description">

  602. <div class="long_description"></div>

  603. <h3>Returns</h3>

  604. <div class="subelement response"><code>int</code></div>

  605. </div></div>

  606. </div>

  607. <a id="method_hasDataValidation"></a><div class="element clickable method public method_hasDataValidation" data-toggle="collapse" data-target=".method_hasDataValidation .collapse">

  608. <h2>Does this cell contain Data validation rules?</h2>

  609. <pre>hasDataValidation() : boolean</pre>

  610. <div class="labels"></div>

  611. <div class="row collapse"><div class="detail-description">

  612. <div class="long_description"></div>

  613. <h3>Exceptions</h3>

  614. <table class="table table-bordered"><tr>

  615. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>

  616. <td></td>

  617. </tr></table>

  618. <h3>Returns</h3>

  619. <div class="subelement response"><code>boolean</code></div>

  620. </div></div>

  621. </div>

  622. <a id="method_hasHyperlink"></a><div class="element clickable method public method_hasHyperlink" data-toggle="collapse" data-target=".method_hasHyperlink .collapse">

  623. <h2>Does this cell contain a Hyperlink?</h2>

  624. <pre>hasHyperlink() : boolean</pre>

  625. <div class="labels"></div>

  626. <div class="row collapse"><div class="detail-description">

  627. <div class="long_description"></div>

  628. <h3>Exceptions</h3>

  629. <table class="table table-bordered"><tr>

  630. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>

  631. <td></td>

  632. </tr></table>

  633. <h3>Returns</h3>

  634. <div class="subelement response"><code>boolean</code></div>

  635. </div></div>

  636. </div>

  637. <a id="method_isFormula"></a><div class="element clickable method public method_isFormula" data-toggle="collapse" data-target=".method_isFormula .collapse">

  638. <h2>Identify if the cell contains a formula</h2>

  639. <pre>isFormula() </pre>

  640. <div class="labels"></div>

  641. <div class="row collapse"><div class="detail-description"><div class="long_description"><p>@return boolean</p></div></div></div>

  642. </div>

  643. <a id="method_isInRange"></a><div class="element clickable method public method_isInRange" data-toggle="collapse" data-target=".method_isInRange .collapse">

  644. <h2>Is cell in a specific range?</h2>

  645. <pre>isInRange(string $pRange) : boolean</pre>

  646. <div class="labels"></div>

  647. <div class="row collapse"><div class="detail-description">

  648. <div class="long_description"></div>

  649. <h3>Parameters</h3>

  650. <div class="subelement argument">

  651. <h4>$pRange</h4>

  652. <code>string</code><p>Cell range (e.g. A1:A1)</p>

  653. </div>

  654. <h3>Returns</h3>

  655. <div class="subelement response"><code>boolean</code></div>

  656. </div></div>

  657. </div>

  658. <a id="method_notifyCacheController"></a><div class="element clickable method public method_notifyCacheController" data-toggle="collapse" data-target=".method_notifyCacheController .collapse">

  659. <h2>Send notification to the cache controller</h2>

  660. <pre>notifyCacheController() : void</pre>

  661. <div class="labels"></div>

  662. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  663. </div>

  664. <a id="method_rangeBoundaries"></a><div class="element clickable method public method_rangeBoundaries" data-toggle="collapse" data-target=".method_rangeBoundaries .collapse">

  665. <h2>Calculate range boundaries</h2>

  666. <pre>rangeBoundaries(string $pRange) : array</pre>

  667. <div class="labels"><span class="label">Static</span></div>

  668. <div class="row collapse"><div class="detail-description">

  669. <div class="long_description"></div>

  670. <h3>Parameters</h3>

  671. <div class="subelement argument">

  672. <h4>$pRange</h4>

  673. <code>string</code><p>Cell range (e.g. A1:A1)</p>

  674. </div>

  675. <h3>Returns</h3>

  676. <div class="subelement response">

  677. <code>array</code>Range coordinates array(Start Cell, End Cell)

  678. 				where Start Cell and End Cell are arrays (Column Number, Row Number)</div>

  679. </div></div>

  680. </div>

  681. <a id="method_rangeDimension"></a><div class="element clickable method public method_rangeDimension" data-toggle="collapse" data-target=".method_rangeDimension .collapse">

  682. <h2>Calculate range dimension</h2>

  683. <pre>rangeDimension(string $pRange) : array</pre>

  684. <div class="labels"><span class="label">Static</span></div>

  685. <div class="row collapse"><div class="detail-description">

  686. <div class="long_description"></div>

  687. <h3>Parameters</h3>

  688. <div class="subelement argument">

  689. <h4>$pRange</h4>

  690. <code>string</code><p>Cell range (e.g. A1:A1)</p>

  691. </div>

  692. <h3>Returns</h3>

  693. <div class="subelement response">

  694. <code>array</code>Range dimension (width, height)</div>

  695. </div></div>

  696. </div>

  697. <a id="method_rebindParent"></a><div class="element clickable method public method_rebindParent" data-toggle="collapse" data-target=".method_rebindParent .collapse">

  698. <h2>Re-bind parent</h2>

  699. <pre>rebindParent(\PHPExcel_Worksheet $parent) : <a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></pre>

  700. <div class="labels"></div>

  701. <div class="row collapse"><div class="detail-description">

  702. <div class="long_description"></div>

  703. <h3>Parameters</h3>

  704. <div class="subelement argument">

  705. <h4>$parent</h4>

  706. <code><a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></code>

  707. </div>

  708. <h3>Returns</h3>

  709. <div class="subelement response"><code><a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></code></div>

  710. </div></div>

  711. </div>

  712. <a id="method_setCalculatedValue"></a><div class="element clickable method public method_setCalculatedValue" data-toggle="collapse" data-target=".method_setCalculatedValue .collapse">

  713. <h2>Set old calculated value (cached)</h2>

  714. <pre>setCalculatedValue(mixed $pValue) : <a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></pre>

  715. <div class="labels"></div>

  716. <div class="row collapse"><div class="detail-description">

  717. <div class="long_description"></div>

  718. <h3>Parameters</h3>

  719. <div class="subelement argument">

  720. <h4>$pValue</h4>

  721. <code>mixed</code><p>Value</p></div>

  722. <h3>Returns</h3>

  723. <div class="subelement response"><code><a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></code></div>

  724. </div></div>

  725. </div>

  726. <a id="method_setDataType"></a><div class="element clickable method public method_setDataType" data-toggle="collapse" data-target=".method_setDataType .collapse">

  727. <h2>Set cell data type</h2>

  728. <pre>setDataType(string $pDataType) : <a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></pre>

  729. <div class="labels"></div>

  730. <div class="row collapse"><div class="detail-description">

  731. <div class="long_description"></div>

  732. <h3>Parameters</h3>

  733. <div class="subelement argument">

  734. <h4>$pDataType</h4>

  735. <code>string</code>

  736. </div>

  737. <h3>Returns</h3>

  738. <div class="subelement response"><code><a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></code></div>

  739. </div></div>

  740. </div>

  741. <a id="method_setDataValidation"></a><div class="element clickable method public method_setDataValidation" data-toggle="collapse" data-target=".method_setDataValidation .collapse">

  742. <h2>Set Data validation rules</h2>

  743. <pre>setDataValidation(\PHPExcel_Cell_DataValidation $pDataValidation) : <a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></pre>

  744. <div class="labels"></div>

  745. <div class="row collapse"><div class="detail-description">

  746. <div class="long_description"></div>

  747. <h3>Parameters</h3>

  748. <div class="subelement argument">

  749. <h4>$pDataValidation</h4>

  750. <code><a href="../classes/PHPExcel_Cell_DataValidation.html">\PHPExcel_Cell_DataValidation</a></code>

  751. </div>

  752. <h3>Exceptions</h3>

  753. <table class="table table-bordered"><tr>

  754. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>

  755. <td></td>

  756. </tr></table>

  757. <h3>Returns</h3>

  758. <div class="subelement response"><code><a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></code></div>

  759. </div></div>

  760. </div>

  761. <a id="method_setFormulaAttributes"></a><div class="element clickable method public method_setFormulaAttributes" data-toggle="collapse" data-target=".method_setFormulaAttributes .collapse">

  762. <h2>setFormulaAttributes()

  763.         </h2>

  764. <pre>setFormulaAttributes($pAttributes) </pre>

  765. <div class="labels"></div>

  766. <div class="row collapse"><div class="detail-description">

  767. <div class="long_description"></div>

  768. <table class="table table-bordered"><tr>

  769. <th>deprecated</th>

  770. <td>Since version 1.7.8 for planned changes to cell for array formula handling</td>

  771. </tr></table>

  772. <h3>Parameters</h3>

  773. <div class="subelement argument"><h4>$pAttributes</h4></div>

  774. </div></div>

  775. </div>

  776. <a id="method_setHyperlink"></a><div class="element clickable method public method_setHyperlink" data-toggle="collapse" data-target=".method_setHyperlink .collapse">

  777. <h2>Set Hyperlink</h2>

  778. <pre>setHyperlink(\PHPExcel_Cell_Hyperlink $pHyperlink) : <a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></pre>

  779. <div class="labels"></div>

  780. <div class="row collapse"><div class="detail-description">

  781. <div class="long_description"></div>

  782. <h3>Parameters</h3>

  783. <div class="subelement argument">

  784. <h4>$pHyperlink</h4>

  785. <code><a href="../classes/PHPExcel_Cell_Hyperlink.html">\PHPExcel_Cell_Hyperlink</a></code>

  786. </div>

  787. <h3>Exceptions</h3>

  788. <table class="table table-bordered"><tr>

  789. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>

  790. <td></td>

  791. </tr></table>

  792. <h3>Returns</h3>

  793. <div class="subelement response"><code><a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></code></div>

  794. </div></div>

  795. </div>

  796. <a id="method_setValue"></a><div class="element clickable method public method_setValue" data-toggle="collapse" data-target=".method_setValue .collapse">

  797. <h2>Set cell value</h2>

  798. <pre>setValue(mixed $pValue) : <a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></pre>

  799. <div class="labels"></div>

  800. <div class="row collapse"><div class="detail-description">

  801. <div class="long_description"><p>Sets the value for a cell, automatically determining the datatype using the value binder</p></div>

  802. <h3>Parameters</h3>

  803. <div class="subelement argument">

  804. <h4>$pValue</h4>

  805. <code>mixed</code><p>Value</p></div>

  806. <h3>Exceptions</h3>

  807. <table class="table table-bordered"><tr>

  808. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>

  809. <td></td>

  810. </tr></table>

  811. <h3>Returns</h3>

  812. <div class="subelement response"><code><a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></code></div>

  813. </div></div>

  814. </div>

  815. <a id="method_setValueBinder"></a><div class="element clickable method public method_setValueBinder" data-toggle="collapse" data-target=".method_setValueBinder .collapse">

  816. <h2>Set value binder to use</h2>

  817. <pre>setValueBinder(\PHPExcel_Cell_IValueBinder $binder) </pre>

  818. <div class="labels"><span class="label">Static</span></div>

  819. <div class="row collapse"><div class="detail-description">

  820. <div class="long_description"></div>

  821. <h3>Parameters</h3>

  822. <div class="subelement argument">

  823. <h4>$binder</h4>

  824. <code><a href="../classes/PHPExcel_Cell_IValueBinder.html">\PHPExcel_Cell_IValueBinder</a></code>

  825. </div>

  826. <h3>Exceptions</h3>

  827. <table class="table table-bordered"><tr>

  828. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>

  829. <td></td>

  830. </tr></table>

  831. </div></div>

  832. </div>

  833. <a id="method_setValueExplicit"></a><div class="element clickable method public method_setValueExplicit" data-toggle="collapse" data-target=".method_setValueExplicit .collapse">

  834. <h2>Set the value for a cell, with the explicit data type passed to the method (bypassing any use of the value binder)</h2>

  835. <pre>setValueExplicit(mixed $pValue, string $pDataType) : <a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></pre>

  836. <div class="labels"></div>

  837. <div class="row collapse"><div class="detail-description">

  838. <div class="long_description"></div>

  839. <h3>Parameters</h3>

  840. <div class="subelement argument">

  841. <h4>$pValue</h4>

  842. <code>mixed</code><p>Value</p></div>

  843. <div class="subelement argument">

  844. <h4>$pDataType</h4>

  845. <code>string</code><p>Explicit data type</p></div>

  846. <h3>Exceptions</h3>

  847. <table class="table table-bordered"><tr>

  848. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>

  849. <td></td>

  850. </tr></table>

  851. <h3>Returns</h3>

  852. <div class="subelement response"><code><a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></code></div>

  853. </div></div>

  854. </div>

  855. <a id="method_setXfIndex"></a><div class="element clickable method public method_setXfIndex" data-toggle="collapse" data-target=".method_setXfIndex .collapse">

  856. <h2>Set index to cellXf</h2>

  857. <pre>setXfIndex(int $pValue) : <a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></pre>

  858. <div class="labels"></div>

  859. <div class="row collapse"><div class="detail-description">

  860. <div class="long_description"></div>

  861. <h3>Parameters</h3>

  862. <div class="subelement argument">

  863. <h4>$pValue</h4>

  864. <code>int</code>

  865. </div>

  866. <h3>Returns</h3>

  867. <div class="subelement response"><code><a href="../classes/PHPExcel_Cell.html">\PHPExcel_Cell</a></code></div>

  868. </div></div>

  869. </div>

  870. <a id="method_splitRange"></a><div class="element clickable method public method_splitRange" data-toggle="collapse" data-target=".method_splitRange .collapse">

  871. <h2>Split range into coordinate strings</h2>

  872. <pre>splitRange(string $pRange) : array</pre>

  873. <div class="labels"><span class="label">Static</span></div>

  874. <div class="row collapse"><div class="detail-description">

  875. <div class="long_description"></div>

  876. <h3>Parameters</h3>

  877. <div class="subelement argument">

  878. <h4>$pRange</h4>

  879. <code>string</code><p>e.g. 'B4:D9' or 'B4:D9,H2:O11' or 'B4'</p>

  880. </div>

  881. <h3>Returns</h3>

  882. <div class="subelement response">

  883. <code>array</code>Array containg one or more arrays containing one or two coordinate strings

  884. 							e.g. array('B4','D9') or array(array('B4','D9'),array('H2','O11'))

  885. 									or array('B4')</div>

  886. </div></div>

  887. </div>

  888. <a id="method_stringFromColumnIndex"></a><div class="element clickable method public method_stringFromColumnIndex" data-toggle="collapse" data-target=".method_stringFromColumnIndex .collapse">

  889. <h2>String from columnindex</h2>

  890. <pre>stringFromColumnIndex(int $pColumnIndex) : string</pre>

  891. <div class="labels"><span class="label">Static</span></div>

  892. <div class="row collapse"><div class="detail-description">

  893. <div class="long_description"></div>

  894. <h3>Parameters</h3>

  895. <div class="subelement argument">

  896. <h4>$pColumnIndex</h4>

  897. <code>int</code><p>Column index (base 0 !!!)</p>

  898. </div>

  899. <h3>Returns</h3>

  900. <div class="subelement response"><code>string</code></div>

  901. </div></div>

  902. </div>

  903. <h3>

  904. <i class="icon-custom icon-property"></i> Properties</h3>

  905. <a id="property__calculatedValue"> </a><div class="element clickable property private property__calculatedValue" data-toggle="collapse" data-target=".property__calculatedValue .collapse">

  906. <h2></h2>

  907. <pre>$_calculatedValue : mixed</pre>

  908. <div class="labels"></div>

  909. <div class="row collapse"><div class="detail-description"><div class="long_description"><p>Note that this value is not guaranteed to reflect the actual calculated value because it is

  910.     possible that auto-calculation was disabled in the original spreadsheet, and underlying data

  911.     values used by the formula have changed since it was last calculated.</p></div></div></div>

  912. </div>

  913. <a id="property__dataType"> </a><div class="element clickable property private property__dataType" data-toggle="collapse" data-target=".property__dataType .collapse">

  914. <h2></h2>

  915. <pre>$_dataType : string</pre>

  916. <div class="labels"></div>

  917. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  918. </div>

  919. <a id="property__formulaAttributes"> </a><div class="element clickable property private property__formulaAttributes" data-toggle="collapse" data-target=".property__formulaAttributes .collapse">

  920. <h2></h2>

  921. <pre>$_formulaAttributes </pre>

  922. <div class="labels"></div>

  923. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  924. </div>

  925. <a id="property__parent"> </a><div class="element clickable property private property__parent" data-toggle="collapse" data-target=".property__parent .collapse">

  926. <h2></h2>

  927. <pre>$_parent : <a href="../classes/PHPExcel_CachedObjectStorage_CacheBase.html">\PHPExcel_CachedObjectStorage_CacheBase</a></pre>

  928. <div class="labels"></div>

  929. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  930. </div>

  931. <a id="property__value"> </a><div class="element clickable property private property__value" data-toggle="collapse" data-target=".property__value .collapse">

  932. <h2></h2>

  933. <pre>$_value : mixed</pre>

  934. <div class="labels"></div>

  935. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  936. </div>

  937. <a id="property__valueBinder"> </a><div class="element clickable property private property__valueBinder" data-toggle="collapse" data-target=".property__valueBinder .collapse">

  938. <h2></h2>

  939. <pre>$_valueBinder : <a href="../classes/PHPExcel_Cell_IValueBinder.html">\PHPExcel_Cell_IValueBinder</a></pre>

  940. <div class="labels"></div>

  941. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  942. </div>

  943. <a id="property__xfIndex"> </a><div class="element clickable property private property__xfIndex" data-toggle="collapse" data-target=".property__xfIndex .collapse">

  944. <h2></h2>

  945. <pre>$_xfIndex : int</pre>

  946. <div class="labels"></div>

  947. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  948. </div>

  949. <h3>

  950. <i class="icon-custom icon-constant"></i> Constants</h3>

  951. <a id="constant_DEFAULT_RANGE"> </a><div class="element clickable constant  constant_DEFAULT_RANGE" data-toggle="collapse" data-target=".constant_DEFAULT_RANGE .collapse">

  952. <h2>Default range variable constant</h2>

  953. <pre>DEFAULT_RANGE </pre>

  954. <div class="labels"></div>

  955. <div class="row collapse"><div class="detail-description"><div class="long_description"><p>@var  string</p></div></div></div>

  956. </div>

  957. </div>

  958. </div>

  959. </div>

  960. </div>

  961. <div class="row"><footer class="span12">

  962.             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>

  963.             Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>

  964.             generated on 2014-03-02T15:27:34Z.<br></footer></div>

  965. </div>

  966. </body>

  967. </html>