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

1150 lines
70 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</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 with one Worksheet"><span class="description">Create a new PHPExcel with one Worksheet</span><pre>__construct()</pre></a></li>

  97. <li class="method public "><a href="#method___destruct" title="__destruct :: Code to execute when this worksheet is unset()"><span class="description">Code to execute when this worksheet is unset()</span><pre>__destruct()</pre></a></li>

  98. <li class="method public "><a href="#method_addCellStyleXf" title="addCellStyleXf :: Add a cellStyleXf to the workbook"><span class="description">Add a cellStyleXf to the workbook</span><pre>addCellStyleXf()</pre></a></li>

  99. <li class="method public "><a href="#method_addCellXf" title="addCellXf :: Add a cellXf to the workbook"><span class="description">Add a cellXf to the workbook</span><pre>addCellXf()</pre></a></li>

  100. <li class="method public "><a href="#method_addExternalSheet" title="addExternalSheet :: Add external sheet"><span class="description">Add external sheet</span><pre>addExternalSheet()</pre></a></li>

  101. <li class="method public "><a href="#method_addNamedRange" title="addNamedRange :: Add named range"><span class="description">Add named range</span><pre>addNamedRange()</pre></a></li>

  102. <li class="method public "><a href="#method_addSheet" title="addSheet :: Add sheet"><span class="description">Add sheet</span><pre>addSheet()</pre></a></li>

  103. <li class="method public "><a href="#method_cellXfExists" title="cellXfExists :: Check if style exists in style collection"><span class="description">Check if style exists in style collection</span><pre>cellXfExists()</pre></a></li>

  104. <li class="method public "><a href="#method_copy" title="copy :: Copy workbook (!= clone!)"><span class="description">Copy workbook (!= clone!)</span><pre>copy()</pre></a></li>

  105. <li class="method public "><a href="#method_createSheet" title="createSheet :: Create sheet and add it to this workbook"><span class="description">Create sheet and add it to this workbook</span><pre>createSheet()</pre></a></li>

  106. <li class="method public "><a href="#method_discardMacros" title="discardMacros :: Remove all macros, certificate from spreadsheet"><span class="description">Remove all macros, certificate from spreadsheet</span><pre>discardMacros()</pre></a></li>

  107. <li class="method public "><a href="#method_disconnectWorksheets" title="disconnectWorksheets :: Disconnect all worksheets from this PHPExcel workbook object,

  108.    typically so that the PHPExcel object can be unset"><span class="description">Disconnect all worksheets from this PHPExcel workbook object,

  109.    typically so that the PHPExcel object can be unset</span><pre>disconnectWorksheets()</pre></a></li>

  110. <li class="method public "><a href="#method_garbageCollect" title="garbageCollect :: Eliminate all unneeded cellXf and afterwards update the xfIndex for all cells

  111. and columns in the workbook"><span class="description">Eliminate all unneeded cellXf and afterwards update the xfIndex for all cells

  112. and columns in the workbook</span><pre>garbageCollect()</pre></a></li>

  113. <li class="method public "><a href="#method_getActiveSheet" title="getActiveSheet :: Get active sheet"><span class="description">Get active sheet</span><pre>getActiveSheet()</pre></a></li>

  114. <li class="method public "><a href="#method_getActiveSheetIndex" title="getActiveSheetIndex :: Get active sheet index"><span class="description">Get active sheet index</span><pre>getActiveSheetIndex()</pre></a></li>

  115. <li class="method public "><a href="#method_getAllSheets" title="getAllSheets :: Get all sheets"><span class="description">Get all sheets</span><pre>getAllSheets()</pre></a></li>

  116. <li class="method public "><a href="#method_getCalculationEngine" title="getCalculationEngine :: Return the calculation engine for this worksheet"><span class="description">Return the calculation engine for this worksheet</span><pre>getCalculationEngine()</pre></a></li>

  117. <li class="method public "><a href="#method_getCellStyleXfByHashCode" title="getCellStyleXfByHashCode :: Get cellStyleXf by hash code"><span class="description">Get cellStyleXf by hash code</span><pre>getCellStyleXfByHashCode()</pre></a></li>

  118. <li class="method public "><a href="#method_getCellStyleXfByIndex" title="getCellStyleXfByIndex :: Get cellStyleXf by index"><span class="description">Get cellStyleXf by index</span><pre>getCellStyleXfByIndex()</pre></a></li>

  119. <li class="method public "><a href="#method_getCellStyleXfCollection" title="getCellStyleXfCollection :: Get the workbook collection of cellStyleXfs"><span class="description">Get the workbook collection of cellStyleXfs</span><pre>getCellStyleXfCollection()</pre></a></li>

  120. <li class="method public "><a href="#method_getCellXfByHashCode" title="getCellXfByHashCode :: Get cellXf by hash code"><span class="description">Get cellXf by hash code</span><pre>getCellXfByHashCode()</pre></a></li>

  121. <li class="method public "><a href="#method_getCellXfByIndex" title="getCellXfByIndex :: Get cellXf by index"><span class="description">Get cellXf by index</span><pre>getCellXfByIndex()</pre></a></li>

  122. <li class="method public "><a href="#method_getCellXfCollection" title="getCellXfCollection :: Get the workbook collection of cellXfs"><span class="description">Get the workbook collection of cellXfs</span><pre>getCellXfCollection()</pre></a></li>

  123. <li class="method public "><a href="#method_getCellXfSupervisor" title="getCellXfSupervisor :: Get the cellXf supervisor"><span class="description">Get the cellXf supervisor</span><pre>getCellXfSupervisor()</pre></a></li>

  124. <li class="method public "><a href="#method_getDefaultStyle" title="getDefaultStyle :: Get default style"><span class="description">Get default style</span><pre>getDefaultStyle()</pre></a></li>

  125. <li class="method public "><a href="#method_getID" title="getID :: Return the unique ID value assigned to this spreadsheet workbook"><span class="description">Return the unique ID value assigned to this spreadsheet workbook</span><pre>getID()</pre></a></li>

  126. <li class="method public "><a href="#method_getIndex" title="getIndex :: Get index for sheet"><span class="description">Get index for sheet</span><pre>getIndex()</pre></a></li>

  127. <li class="method public "><a href="#method_getMacrosCertificate" title="getMacrosCertificate :: Return the macros certificate"><span class="description">Return the macros certificate</span><pre>getMacrosCertificate()</pre></a></li>

  128. <li class="method public "><a href="#method_getMacrosCode" title="getMacrosCode :: Return the macros code"><span class="description">Return the macros code</span><pre>getMacrosCode()</pre></a></li>

  129. <li class="method public "><a href="#method_getNamedRange" title="getNamedRange :: Get named range"><span class="description">Get named range</span><pre>getNamedRange()</pre></a></li>

  130. <li class="method public "><a href="#method_getNamedRanges" title="getNamedRanges :: Get named ranges"><span class="description">Get named ranges</span><pre>getNamedRanges()</pre></a></li>

  131. <li class="method public "><a href="#method_getProperties" title="getProperties :: Get properties"><span class="description">Get properties</span><pre>getProperties()</pre></a></li>

  132. <li class="method public "><a href="#method_getRibbonBinObjects" title="getRibbonBinObjects :: retrieve Binaries Ribbon Objects"><span class="description">retrieve Binaries Ribbon Objects</span><pre>getRibbonBinObjects()</pre></a></li>

  133. <li class="method public "><a href="#method_getRibbonXMLData" title="getRibbonXMLData :: retrieve ribbon XML Data"><span class="description">retrieve ribbon XML Data</span><pre>getRibbonXMLData()</pre></a></li>

  134. <li class="method public "><a href="#method_getSecurity" title="getSecurity :: Get security"><span class="description">Get security</span><pre>getSecurity()</pre></a></li>

  135. <li class="method public "><a href="#method_getSheet" title="getSheet :: Get sheet by index"><span class="description">Get sheet by index</span><pre>getSheet()</pre></a></li>

  136. <li class="method public "><a href="#method_getSheetByCodeName" title="getSheetByCodeName :: Get sheet by code name."><span class="description">Get sheet by code name.</span><pre>getSheetByCodeName()</pre></a></li>

  137. <li class="method public "><a href="#method_getSheetByName" title="getSheetByName :: Get sheet by name"><span class="description">Get sheet by name</span><pre>getSheetByName()</pre></a></li>

  138. <li class="method public "><a href="#method_getSheetCount" title="getSheetCount :: Get sheet count"><span class="description">Get sheet count</span><pre>getSheetCount()</pre></a></li>

  139. <li class="method public "><a href="#method_getSheetNames" title="getSheetNames :: Get sheet names"><span class="description">Get sheet names</span><pre>getSheetNames()</pre></a></li>

  140. <li class="method public "><a href="#method_getWorksheetIterator" title="getWorksheetIterator :: Get worksheet iterator"><span class="description">Get worksheet iterator</span><pre>getWorksheetIterator()</pre></a></li>

  141. <li class="method public "><a href="#method_hasMacros" title="hasMacros :: The workbook has macros ?"><span class="description">The workbook has macros ?</span><pre>hasMacros()</pre></a></li>

  142. <li class="method public "><a href="#method_hasMacrosCertificate" title="hasMacrosCertificate :: Is the project signed ?"><span class="description">Is the project signed ?</span><pre>hasMacrosCertificate()</pre></a></li>

  143. <li class="method public "><a href="#method_hasRibbon" title="hasRibbon :: This workbook have a custom UI ?"><span class="description">This workbook have a custom UI ?</span><pre>hasRibbon()</pre></a></li>

  144. <li class="method public "><a href="#method_hasRibbonBinObjects" title="hasRibbonBinObjects :: This workbook have additionnal object for the ribbon ?"><span class="description">This workbook have additionnal object for the ribbon ?</span><pre>hasRibbonBinObjects()</pre></a></li>

  145. <li class="method public "><a href="#method_removeCellStyleXfByIndex" title="removeCellStyleXfByIndex :: Remove cellStyleXf by index"><span class="description">Remove cellStyleXf by index</span><pre>removeCellStyleXfByIndex()</pre></a></li>

  146. <li class="method public "><a href="#method_removeCellXfByIndex" title="removeCellXfByIndex :: Remove cellXf by index."><span class="description">Remove cellXf by index.</span><pre>removeCellXfByIndex()</pre></a></li>

  147. <li class="method public "><a href="#method_removeNamedRange" title="removeNamedRange :: Remove named range"><span class="description">Remove named range</span><pre>removeNamedRange()</pre></a></li>

  148. <li class="method public "><a href="#method_removeSheetByIndex" title="removeSheetByIndex :: Remove sheet by index"><span class="description">Remove sheet by index</span><pre>removeSheetByIndex()</pre></a></li>

  149. <li class="method public "><a href="#method_setActiveSheetIndex" title="setActiveSheetIndex :: Set active sheet index"><span class="description">Set active sheet index</span><pre>setActiveSheetIndex()</pre></a></li>

  150. <li class="method public "><a href="#method_setActiveSheetIndexByName" title="setActiveSheetIndexByName :: Set active sheet index by name"><span class="description">Set active sheet index by name</span><pre>setActiveSheetIndexByName()</pre></a></li>

  151. <li class="method public "><a href="#method_setHasMacros" title="setHasMacros :: Define if a workbook has macros"><span class="description">Define if a workbook has macros</span><pre>setHasMacros()</pre></a></li>

  152. <li class="method public "><a href="#method_setIndexByName" title="setIndexByName :: Set index for sheet by sheet name."><span class="description">Set index for sheet by sheet name.</span><pre>setIndexByName()</pre></a></li>

  153. <li class="method public "><a href="#method_setMacrosCertificate" title="setMacrosCertificate :: Set the macros certificate"><span class="description">Set the macros certificate</span><pre>setMacrosCertificate()</pre></a></li>

  154. <li class="method public "><a href="#method_setMacrosCode" title="setMacrosCode :: Set the macros code"><span class="description">Set the macros code</span><pre>setMacrosCode()</pre></a></li>

  155. <li class="method public "><a href="#method_setProperties" title="setProperties :: Set properties"><span class="description">Set properties</span><pre>setProperties()</pre></a></li>

  156. <li class="method public "><a href="#method_setRibbonBinObjects" title="setRibbonBinObjects :: store binaries ribbon objects (pictures)"><span class="description">store binaries ribbon objects (pictures)</span><pre>setRibbonBinObjects()</pre></a></li>

  157. <li class="method public "><a href="#method_setRibbonXMLData" title="setRibbonXMLData :: set ribbon XML data"><span class="description">set ribbon XML data</span><pre>setRibbonXMLData()</pre></a></li>

  158. <li class="method public "><a href="#method_setSecurity" title="setSecurity :: Set security"><span class="description">Set security</span><pre>setSecurity()</pre></a></li>

  159. <li class="method public "><a href="#method_sheetCodeNameExists" title="sheetCodeNameExists :: Check if a sheet with a specified code name already exists"><span class="description">Check if a sheet with a specified code name already exists</span><pre>sheetCodeNameExists()</pre></a></li>

  160. <li class="method public "><a href="#method_sheetNameExists" title="sheetNameExists :: Check if a sheet with a specified name already exists"><span class="description">Check if a sheet with a specified name already exists</span><pre>sheetNameExists()</pre></a></li>

  161. </ul>

  162. </li>

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

  164.                     <ul><li class="method private "><a href="#method__getExtensionOnly" title="_getExtensionOnly :: return the extension of a filename."><span class="description">return the extension of a filename.</span><pre>_getExtensionOnly()</pre></a></li></ul>

  165. </li>

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

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

  168.                     <ul></ul>

  169. </li>

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

  171.                     <ul>

  172. <li class="property private "><a href="#property__activeSheetIndex" title="$_activeSheetIndex :: Active sheet index"><span class="description"></span><pre>$_activeSheetIndex</pre></a></li>

  173. <li class="property private "><a href="#property__calculationEngine" title="$_calculationEngine :: Calculation Engine"><span class="description"></span><pre>$_calculationEngine</pre></a></li>

  174. <li class="property private "><a href="#property__cellStyleXfCollection" title="$_cellStyleXfCollection :: CellStyleXf collection"><span class="description"></span><pre>$_cellStyleXfCollection</pre></a></li>

  175. <li class="property private "><a href="#property__cellXfCollection" title="$_cellXfCollection :: CellXf collection"><span class="description"></span><pre>$_cellXfCollection</pre></a></li>

  176. <li class="property private "><a href="#property__cellXfSupervisor" title="$_cellXfSupervisor :: CellXf supervisor"><span class="description"></span><pre>$_cellXfSupervisor</pre></a></li>

  177. <li class="property private "><a href="#property__hasMacros" title="$_hasMacros :: _hasMacros : this workbook have macros ?"><span class="description"></span><pre>$_hasMacros</pre></a></li>

  178. <li class="property private "><a href="#property__macrosCertificate" title="$_macrosCertificate :: _macrosCertificate : if macros are signed, contains vbaProjectSignature.bin file, NULL if not signed"><span class="description"></span><pre>$_macrosCertificate</pre></a></li>

  179. <li class="property private "><a href="#property__macrosCode" title="$_macrosCode :: _macrosCode : all macros code (the vbaProject.bin file, this include form, code,  etc.), NULL if no macro"><span class="description"></span><pre>$_macrosCode</pre></a></li>

  180. <li class="property private "><a href="#property__namedRanges" title="$_namedRanges :: Named ranges"><span class="description"></span><pre>$_namedRanges</pre></a></li>

  181. <li class="property private "><a href="#property__properties" title="$_properties :: Document properties"><span class="description"></span><pre>$_properties</pre></a></li>

  182. <li class="property private "><a href="#property__ribbonBinObjects" title="$_ribbonBinObjects :: _ribbonBinObjects : NULL if workbook is'nt Excel 2007 or not contain embedded objects (picture(s)) for Ribbon Elements

  183. ignored if $_ribbonXMLData is null"><span class="description"></span><pre>$_ribbonBinObjects</pre></a></li>

  184. <li class="property private "><a href="#property__ribbonXMLData" title="$_ribbonXMLData :: _ribbonXMLData : NULL if workbook is'nt Excel 2007 or not contain a customized UI"><span class="description"></span><pre>$_ribbonXMLData</pre></a></li>

  185. <li class="property private "><a href="#property__security" title="$_security :: Document security"><span class="description"></span><pre>$_security</pre></a></li>

  186. <li class="property private "><a href="#property__uniqueID" title="$_uniqueID :: Unique ID"><span class="description"></span><pre>$_uniqueID</pre></a></li>

  187. <li class="property private "><a href="#property__workSheetCollection" title="$_workSheetCollection :: Collection of Worksheet objects"><span class="description"></span><pre>$_workSheetCollection</pre></a></li>

  188. </ul>

  189. </li>

  190. </ul>

  191. </div>

  192. <div class="span8">

  193. <a id="\PHPExcel"></a><ul class="breadcrumb">

  194. <li>

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

  196. </li>

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

  198. <li class="active">

  199. <span class="divider">\</span><a href="../classes/PHPExcel.html">PHPExcel</a>

  200. </li>

  201. </ul>

  202. <div class="element class">

  203. <p class="short_description">PHPExcel</p>

  204. <div class="details">

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

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

  207. <tr>

  208. <th>category</th>

  209. <td>PHPExcel</td>

  210. </tr>

  211. <tr>

  212. <th>package</th>

  213. <td><a href="../packages/PHPExcel.html">PHPExcel</a></td>

  214. </tr>

  215. <tr>

  216. <th>copyright</th>

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

  218. </tr>

  219. </table>

  220. <h3>

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

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

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

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

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

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

  227. </div>

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

  229. <h2>Create a new PHPExcel with one Worksheet</h2>

  230. <pre>__construct() </pre>

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

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

  233. </div>

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

  235. <h2>Code to execute when this worksheet is unset()</h2>

  236. <pre>__destruct() </pre>

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

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

  239. </div>

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

  241. <h2>Add a cellStyleXf to the workbook</h2>

  242. <pre>addCellStyleXf(\PHPExcel_Style $pStyle) </pre>

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

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

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

  246. <h3>Parameters</h3>

  247. <div class="subelement argument">

  248. <h4>$pStyle</h4>

  249. <code><a href="../classes/PHPExcel_Style.html">\PHPExcel_Style</a></code>

  250. </div>

  251. </div></div>

  252. </div>

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

  254. <h2>Add a cellXf to the workbook</h2>

  255. <pre>addCellXf(\PHPExcel_Style $style) </pre>

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

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

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

  259. <h3>Parameters</h3>

  260. <div class="subelement argument">

  261. <h4>$style</h4>

  262. <code><a href="../classes/PHPExcel_Style.html">\PHPExcel_Style</a></code>

  263. </div>

  264. </div></div>

  265. </div>

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

  267. <h2>Add external sheet</h2>

  268. <pre>addExternalSheet(\PHPExcel_Worksheet $pSheet, int | null $iSheetIndex) : <a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></pre>

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

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

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

  272. <h3>Parameters</h3>

  273. <div class="subelement argument">

  274. <h4>$pSheet</h4>

  275. <code><a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></code><p>External sheet to add</p></div>

  276. <div class="subelement argument">

  277. <h4>$iSheetIndex</h4>

  278. <code>int</code><code>null</code><p>Index where sheet should go (0,1,..., or null for last)</p>

  279. </div>

  280. <h3>Exceptions</h3>

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

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

  283. <td></td>

  284. </tr></table>

  285. <h3>Returns</h3>

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

  287. </div></div>

  288. </div>

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

  290. <h2>Add named range</h2>

  291. <pre>addNamedRange(\PHPExcel_NamedRange $namedRange) : <a href="../classes/PHPExcel.html">\PHPExcel</a></pre>

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

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

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

  295. <h3>Parameters</h3>

  296. <div class="subelement argument">

  297. <h4>$namedRange</h4>

  298. <code><a href="../classes/PHPExcel_NamedRange.html">\PHPExcel_NamedRange</a></code>

  299. </div>

  300. <h3>Returns</h3>

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

  302. </div></div>

  303. </div>

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

  305. <h2>Add sheet</h2>

  306. <pre>addSheet(\PHPExcel_Worksheet $pSheet, int | null $iSheetIndex) : <a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></pre>

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

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

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

  310. <h3>Parameters</h3>

  311. <div class="subelement argument">

  312. <h4>$pSheet</h4>

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

  314. </div>

  315. <div class="subelement argument">

  316. <h4>$iSheetIndex</h4>

  317. <code>int</code><code>null</code><p>Index where sheet should go (0,1,..., or null for last)</p>

  318. </div>

  319. <h3>Exceptions</h3>

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

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

  322. <td></td>

  323. </tr></table>

  324. <h3>Returns</h3>

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

  326. </div></div>

  327. </div>

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

  329. <h2>Check if style exists in style collection</h2>

  330. <pre>cellXfExists(<a href="../classes/PHPExcel_Style.html">\PHPExcel_Style</a> $pCellStyle) : boolean</pre>

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

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

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

  334. <h3>Parameters</h3>

  335. <div class="subelement argument">

  336. <h4>$pCellStyle</h4>

  337. <code><a href="../classes/PHPExcel_Style.html">\PHPExcel_Style</a></code>

  338. </div>

  339. <h3>Returns</h3>

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

  341. </div></div>

  342. </div>

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

  344. <h2>Copy workbook (!= clone!)</h2>

  345. <pre>copy() : <a href="../classes/PHPExcel.html">\PHPExcel</a></pre>

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

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

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

  349. <h3>Returns</h3>

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

  351. </div></div>

  352. </div>

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

  354. <h2>Create sheet and add it to this workbook</h2>

  355. <pre>createSheet(int | null $iSheetIndex) : <a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></pre>

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

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

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

  359. <h3>Parameters</h3>

  360. <div class="subelement argument">

  361. <h4>$iSheetIndex</h4>

  362. <code>int</code><code>null</code><p>Index where sheet should go (0,1,..., or null for last)</p>

  363. </div>

  364. <h3>Exceptions</h3>

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

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

  367. <td></td>

  368. </tr></table>

  369. <h3>Returns</h3>

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

  371. </div></div>

  372. </div>

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

  374. <h2>Remove all macros, certificate from spreadsheet</h2>

  375. <pre>discardMacros() : void</pre>

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

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

  378. </div>

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

  380. <h2>Disconnect all worksheets from this PHPExcel workbook object,

  381.    typically so that the PHPExcel object can be unset</h2>

  382. <pre>disconnectWorksheets() </pre>

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

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

  385. </div>

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

  387. <h2>Eliminate all unneeded cellXf and afterwards update the xfIndex for all cells

  388. and columns in the workbook</h2>

  389. <pre>garbageCollect() </pre>

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

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

  392. </div>

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

  394. <h2>Get active sheet</h2>

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

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

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

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

  399. <h3>Returns</h3>

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

  401. </div></div>

  402. </div>

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

  404. <h2>Get active sheet index</h2>

  405. <pre>getActiveSheetIndex() : int</pre>

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

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

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

  409. <h3>Returns</h3>

  410. <div class="subelement response">

  411. <code>int</code>Active sheet index</div>

  412. </div></div>

  413. </div>

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

  415. <h2>Get all sheets</h2>

  416. <pre>getAllSheets() : <a href="PHPExcel.Worksheet.html#%5CPHPExcel_Worksheet">\PHPExcel_Worksheet[]</a></pre>

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

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

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

  420. <h3>Returns</h3>

  421. <div class="subelement response"><code><a href="PHPExcel.Worksheet.html#%5CPHPExcel_Worksheet">\PHPExcel_Worksheet[]</a></code></div>

  422. </div></div>

  423. </div>

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

  425. <h2>Return the calculation engine for this worksheet</h2>

  426. <pre>getCalculationEngine() : <a href="../classes/PHPExcel_Calculation.html">\PHPExcel_Calculation</a></pre>

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

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

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

  430. <h3>Returns</h3>

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

  432. </div></div>

  433. </div>

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

  435. <h2>Get cellStyleXf by hash code</h2>

  436. <pre>getCellStyleXfByHashCode(string $pValue) : <a href="../classes/PHPExcel_Style.html">\PHPExcel_Style</a> | false</pre>

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

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

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

  440. <h3>Parameters</h3>

  441. <div class="subelement argument">

  442. <h4>$pValue</h4>

  443. <code>string</code>

  444. </div>

  445. <h3>Returns</h3>

  446. <div class="subelement response">

  447. <code><a href="../classes/PHPExcel_Style.html">\PHPExcel_Style</a></code><code>false</code>

  448. </div>

  449. </div></div>

  450. </div>

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

  452. <h2>Get cellStyleXf by index</h2>

  453. <pre>getCellStyleXfByIndex(int $pIndex) : <a href="../classes/PHPExcel_Style.html">\PHPExcel_Style</a></pre>

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

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

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

  457. <h3>Parameters</h3>

  458. <div class="subelement argument">

  459. <h4>$pIndex</h4>

  460. <code>int</code>

  461. </div>

  462. <h3>Returns</h3>

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

  464. </div></div>

  465. </div>

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

  467. <h2>Get the workbook collection of cellStyleXfs</h2>

  468. <pre>getCellStyleXfCollection() : <a href="PHPExcel.Style.html#%5CPHPExcel_Style">\PHPExcel_Style[]</a></pre>

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

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

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

  472. <h3>Returns</h3>

  473. <div class="subelement response"><code><a href="PHPExcel.Style.html#%5CPHPExcel_Style">\PHPExcel_Style[]</a></code></div>

  474. </div></div>

  475. </div>

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

  477. <h2>Get cellXf by hash code</h2>

  478. <pre>getCellXfByHashCode(string $pValue) : <a href="../classes/PHPExcel_Style.html">\PHPExcel_Style</a> | false</pre>

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

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

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

  482. <h3>Parameters</h3>

  483. <div class="subelement argument">

  484. <h4>$pValue</h4>

  485. <code>string</code>

  486. </div>

  487. <h3>Returns</h3>

  488. <div class="subelement response">

  489. <code><a href="../classes/PHPExcel_Style.html">\PHPExcel_Style</a></code><code>false</code>

  490. </div>

  491. </div></div>

  492. </div>

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

  494. <h2>Get cellXf by index</h2>

  495. <pre>getCellXfByIndex(int $pIndex) : <a href="../classes/PHPExcel_Style.html">\PHPExcel_Style</a></pre>

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

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

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

  499. <h3>Parameters</h3>

  500. <div class="subelement argument">

  501. <h4>$pIndex</h4>

  502. <code>int</code>

  503. </div>

  504. <h3>Returns</h3>

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

  506. </div></div>

  507. </div>

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

  509. <h2>Get the workbook collection of cellXfs</h2>

  510. <pre>getCellXfCollection() : <a href="PHPExcel.Style.html#%5CPHPExcel_Style">\PHPExcel_Style[]</a></pre>

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

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

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

  514. <h3>Returns</h3>

  515. <div class="subelement response"><code><a href="PHPExcel.Style.html#%5CPHPExcel_Style">\PHPExcel_Style[]</a></code></div>

  516. </div></div>

  517. </div>

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

  519. <h2>Get the cellXf supervisor</h2>

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

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

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

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

  524. <h3>Returns</h3>

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

  526. </div></div>

  527. </div>

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

  529. <h2>Get default style</h2>

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

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

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

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

  534. <h3>Exceptions</h3>

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

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

  537. <td></td>

  538. </tr></table>

  539. <h3>Returns</h3>

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

  541. </div></div>

  542. </div>

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

  544. <h2>Return the unique ID value assigned to this spreadsheet workbook</h2>

  545. <pre>getID() : string</pre>

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

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

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

  549. <h3>Returns</h3>

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

  551. </div></div>

  552. </div>

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

  554. <h2>Get index for sheet</h2>

  555. <pre>getIndex(\PHPExcel_Worksheet $pSheet) : \Sheet</pre>

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

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

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

  559. <h3>Parameters</h3>

  560. <div class="subelement argument">

  561. <h4>$pSheet</h4>

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

  563. </div>

  564. <h3>Exceptions</h3>

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

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

  567. <td></td>

  568. </tr></table>

  569. <h3>Returns</h3>

  570. <div class="subelement response">

  571. <code>\Sheet</code>index</div>

  572. </div></div>

  573. </div>

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

  575. <h2>Return the macros certificate</h2>

  576. <pre>getMacrosCertificate() : \binary | null</pre>

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

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

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

  580. <h3>Returns</h3>

  581. <div class="subelement response">

  582. <code>\binary</code><code>null</code>

  583. </div>

  584. </div></div>

  585. </div>

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

  587. <h2>Return the macros code</h2>

  588. <pre>getMacrosCode() : \binary | null</pre>

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

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

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

  592. <h3>Returns</h3>

  593. <div class="subelement response">

  594. <code>\binary</code><code>null</code>

  595. </div>

  596. </div></div>

  597. </div>

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

  599. <h2>Get named range</h2>

  600. <pre>getNamedRange(string $namedRange, \PHPExcel_Worksheet $pSheet) : <a href="../classes/PHPExcel_NamedRange.html">\PHPExcel_NamedRange</a> | null</pre>

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

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

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

  604. <h3>Parameters</h3>

  605. <div class="subelement argument">

  606. <h4>$namedRange</h4>

  607. <code>string</code>

  608. </div>

  609. <div class="subelement argument">

  610. <h4>$pSheet</h4>

  611. <code><a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></code><code>null</code><p>Scope. Use null for global scope</p></div>

  612. <h3>Returns</h3>

  613. <div class="subelement response">

  614. <code><a href="../classes/PHPExcel_NamedRange.html">\PHPExcel_NamedRange</a></code><code>null</code>

  615. </div>

  616. </div></div>

  617. </div>

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

  619. <h2>Get named ranges</h2>

  620. <pre>getNamedRanges() : <a href="PHPExcel.NamedRange.html#%5CPHPExcel_NamedRange">\PHPExcel_NamedRange[]</a></pre>

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

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

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

  624. <h3>Returns</h3>

  625. <div class="subelement response"><code><a href="PHPExcel.NamedRange.html#%5CPHPExcel_NamedRange">\PHPExcel_NamedRange[]</a></code></div>

  626. </div></div>

  627. </div>

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

  629. <h2>Get properties</h2>

  630. <pre>getProperties() : <a href="../classes/PHPExcel_DocumentProperties.html">\PHPExcel_DocumentProperties</a></pre>

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

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

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

  634. <h3>Returns</h3>

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

  636. </div></div>

  637. </div>

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

  639. <h2>retrieve Binaries Ribbon Objects</h2>

  640. <pre>getRibbonBinObjects($What) </pre>

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

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

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

  644. <h3>Parameters</h3>

  645. <div class="subelement argument"><h4>$What</h4></div>

  646. </div></div>

  647. </div>

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

  649. <h2>retrieve ribbon XML Data</h2>

  650. <pre>getRibbonXMLData($What) </pre>

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

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

  653. <div class="long_description"><p>return string|null|array</p></div>

  654. <h3>Parameters</h3>

  655. <div class="subelement argument"><h4>$What</h4></div>

  656. </div></div>

  657. </div>

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

  659. <h2>Get security</h2>

  660. <pre>getSecurity() : <a href="../classes/PHPExcel_DocumentSecurity.html">\PHPExcel_DocumentSecurity</a></pre>

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

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

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

  664. <h3>Returns</h3>

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

  666. </div></div>

  667. </div>

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

  669. <h2>Get sheet by index</h2>

  670. <pre>getSheet(int $pIndex) : <a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></pre>

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

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

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

  674. <h3>Parameters</h3>

  675. <div class="subelement argument">

  676. <h4>$pIndex</h4>

  677. <code>int</code><p>Sheet index</p></div>

  678. <h3>Exceptions</h3>

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

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

  681. <td></td>

  682. </tr></table>

  683. <h3>Returns</h3>

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

  685. </div></div>

  686. </div>

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

  688. <h2>Get sheet by code name.</h2>

  689. <pre>getSheetByCodeName(string $pName) : <a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></pre>

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

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

  692. <div class="long_description"><p>Warning : sheet don't have always a code name !</p></div>

  693. <h3>Parameters</h3>

  694. <div class="subelement argument">

  695. <h4>$pName</h4>

  696. <code>string</code><p>Sheet name</p></div>

  697. <h3>Returns</h3>

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

  699. </div></div>

  700. </div>

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

  702. <h2>Get sheet by name</h2>

  703. <pre>getSheetByName(string $pName) : <a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></pre>

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

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

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

  707. <h3>Parameters</h3>

  708. <div class="subelement argument">

  709. <h4>$pName</h4>

  710. <code>string</code><p>Sheet name</p></div>

  711. <h3>Returns</h3>

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

  713. </div></div>

  714. </div>

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

  716. <h2>Get sheet count</h2>

  717. <pre>getSheetCount() : int</pre>

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

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

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

  721. <h3>Returns</h3>

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

  723. </div></div>

  724. </div>

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

  726. <h2>Get sheet names</h2>

  727. <pre>getSheetNames() : string[]</pre>

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

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

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

  731. <h3>Returns</h3>

  732. <div class="subelement response"><code>string[]</code></div>

  733. </div></div>

  734. </div>

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

  736. <h2>Get worksheet iterator</h2>

  737. <pre>getWorksheetIterator() : <a href="../classes/PHPExcel_WorksheetIterator.html">\PHPExcel_WorksheetIterator</a></pre>

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

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

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

  741. <h3>Returns</h3>

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

  743. </div></div>

  744. </div>

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

  746. <h2>The workbook has macros ?</h2>

  747. <pre>hasMacros() : true</pre>

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

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

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

  751. <h3>Returns</h3>

  752. <div class="subelement response">

  753. <code>true</code>if workbook has macros, false if not</div>

  754. </div></div>

  755. </div>

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

  757. <h2>Is the project signed ?</h2>

  758. <pre>hasMacrosCertificate() : true | false</pre>

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

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

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

  762. <h3>Returns</h3>

  763. <div class="subelement response">

  764. <code>true</code><code>false</code>

  765. </div>

  766. </div></div>

  767. </div>

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

  769. <h2>This workbook have a custom UI ?</h2>

  770. <pre>hasRibbon() : true | false</pre>

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

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

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

  774. <h3>Returns</h3>

  775. <div class="subelement response">

  776. <code>true</code><code>false</code>

  777. </div>

  778. </div></div>

  779. </div>

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

  781. <h2>This workbook have additionnal object for the ribbon ?</h2>

  782. <pre>hasRibbonBinObjects() : true | false</pre>

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

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

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

  786. <h3>Returns</h3>

  787. <div class="subelement response">

  788. <code>true</code><code>false</code>

  789. </div>

  790. </div></div>

  791. </div>

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

  793. <h2>Remove cellStyleXf by index</h2>

  794. <pre>removeCellStyleXfByIndex(int $pIndex) </pre>

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

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

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

  798. <h3>Parameters</h3>

  799. <div class="subelement argument">

  800. <h4>$pIndex</h4>

  801. <code>int</code>

  802. </div>

  803. <h3>Exceptions</h3>

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

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

  806. <td></td>

  807. </tr></table>

  808. </div></div>

  809. </div>

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

  811. <h2>Remove cellXf by index.</h2>

  812. <pre>removeCellXfByIndex(int $pIndex) </pre>

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

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

  815. <div class="long_description"><p>It is ensured that all cells get their xf index updated.</p></div>

  816. <h3>Parameters</h3>

  817. <div class="subelement argument">

  818. <h4>$pIndex</h4>

  819. <code>int</code><p>Index to cellXf</p></div>

  820. <h3>Exceptions</h3>

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

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

  823. <td></td>

  824. </tr></table>

  825. </div></div>

  826. </div>

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

  828. <h2>Remove named range</h2>

  829. <pre>removeNamedRange(string $namedRange, \PHPExcel_Worksheet $pSheet) : <a href="../classes/PHPExcel.html">\PHPExcel</a></pre>

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

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

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

  833. <h3>Parameters</h3>

  834. <div class="subelement argument">

  835. <h4>$namedRange</h4>

  836. <code>string</code>

  837. </div>

  838. <div class="subelement argument">

  839. <h4>$pSheet</h4>

  840. <code><a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></code><code>null</code><p>Scope: use null for global scope.</p></div>

  841. <h3>Returns</h3>

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

  843. </div></div>

  844. </div>

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

  846. <h2>Remove sheet by index</h2>

  847. <pre>removeSheetByIndex(int $pIndex) </pre>

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

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

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

  851. <h3>Parameters</h3>

  852. <div class="subelement argument">

  853. <h4>$pIndex</h4>

  854. <code>int</code><p>Active sheet index</p></div>

  855. <h3>Exceptions</h3>

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

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

  858. <td></td>

  859. </tr></table>

  860. </div></div>

  861. </div>

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

  863. <h2>Set active sheet index</h2>

  864. <pre>setActiveSheetIndex(int $pIndex) : <a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></pre>

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

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

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

  868. <h3>Parameters</h3>

  869. <div class="subelement argument">

  870. <h4>$pIndex</h4>

  871. <code>int</code><p>Active sheet index</p></div>

  872. <h3>Exceptions</h3>

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

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

  875. <td></td>

  876. </tr></table>

  877. <h3>Returns</h3>

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

  879. </div></div>

  880. </div>

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

  882. <h2>Set active sheet index by name</h2>

  883. <pre>setActiveSheetIndexByName(string $pValue) : <a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></pre>

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

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

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

  887. <h3>Parameters</h3>

  888. <div class="subelement argument">

  889. <h4>$pValue</h4>

  890. <code>string</code><p>Sheet title</p></div>

  891. <h3>Exceptions</h3>

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

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

  894. <td></td>

  895. </tr></table>

  896. <h3>Returns</h3>

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

  898. </div></div>

  899. </div>

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

  901. <h2>Define if a workbook has macros</h2>

  902. <pre>setHasMacros(true | false $hasMacros) </pre>

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

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

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

  906. <h3>Parameters</h3>

  907. <div class="subelement argument">

  908. <h4>$hasMacros</h4>

  909. <code>true</code><code>false</code>

  910. </div>

  911. </div></div>

  912. </div>

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

  914. <h2>Set index for sheet by sheet name.</h2>

  915. <pre>setIndexByName(string $sheetName, int $newIndex) : \New</pre>

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

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

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

  919. <h3>Parameters</h3>

  920. <div class="subelement argument">

  921. <h4>$sheetName</h4>

  922. <code>string</code><p>Sheet name to modify index for</p></div>

  923. <div class="subelement argument">

  924. <h4>$newIndex</h4>

  925. <code>int</code><p>New index for the sheet</p></div>

  926. <h3>Exceptions</h3>

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

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

  929. <td></td>

  930. </tr></table>

  931. <h3>Returns</h3>

  932. <div class="subelement response">

  933. <code>\New</code>sheet index</div>

  934. </div></div>

  935. </div>

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

  937. <h2>Set the macros certificate</h2>

  938. <pre>setMacrosCertificate(\binary | null $Certificate) </pre>

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

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

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

  942. <h3>Parameters</h3>

  943. <div class="subelement argument">

  944. <h4>$Certificate</h4>

  945. <code>\binary</code><code>null</code>

  946. </div>

  947. </div></div>

  948. </div>

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

  950. <h2>Set the macros code</h2>

  951. <pre>setMacrosCode(\binary $MacrosCode) </pre>

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

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

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

  955. <h3>Parameters</h3>

  956. <div class="subelement argument">

  957. <h4>$MacrosCode</h4>

  958. <code>\binary</code><p>string|null</p></div>

  959. </div></div>

  960. </div>

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

  962. <h2>Set properties</h2>

  963. <pre>setProperties(\PHPExcel_DocumentProperties $pValue) </pre>

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

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

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

  967. <h3>Parameters</h3>

  968. <div class="subelement argument">

  969. <h4>$pValue</h4>

  970. <code><a href="../classes/PHPExcel_DocumentProperties.html">\PHPExcel_DocumentProperties</a></code>

  971. </div>

  972. </div></div>

  973. </div>

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

  975. <h2>store binaries ribbon objects (pictures)</h2>

  976. <pre>setRibbonBinObjects($BinObjectsNames, $BinObjectsData) </pre>

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

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

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

  980. <h3>Parameters</h3>

  981. <div class="subelement argument"><h4>$BinObjectsNames</h4></div>

  982. <div class="subelement argument"><h4>$BinObjectsData</h4></div>

  983. </div></div>

  984. </div>

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

  986. <h2>set ribbon XML data</h2>

  987. <pre>setRibbonXMLData($Target, $XMLData) </pre>

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

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

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

  991. <h3>Parameters</h3>

  992. <div class="subelement argument"><h4>$Target</h4></div>

  993. <div class="subelement argument"><h4>$XMLData</h4></div>

  994. </div></div>

  995. </div>

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

  997. <h2>Set security</h2>

  998. <pre>setSecurity(\PHPExcel_DocumentSecurity $pValue) </pre>

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

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

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

  1002. <h3>Parameters</h3>

  1003. <div class="subelement argument">

  1004. <h4>$pValue</h4>

  1005. <code><a href="../classes/PHPExcel_DocumentSecurity.html">\PHPExcel_DocumentSecurity</a></code>

  1006. </div>

  1007. </div></div>

  1008. </div>

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

  1010. <h2>Check if a sheet with a specified code name already exists</h2>

  1011. <pre>sheetCodeNameExists(string $pSheetCodeName) : boolean</pre>

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

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

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

  1015. <h3>Parameters</h3>

  1016. <div class="subelement argument">

  1017. <h4>$pSheetCodeName</h4>

  1018. <code>string</code><p>Name of the worksheet to check</p></div>

  1019. <h3>Returns</h3>

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

  1021. </div></div>

  1022. </div>

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

  1024. <h2>Check if a sheet with a specified name already exists</h2>

  1025. <pre>sheetNameExists(string $pSheetName) : boolean</pre>

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

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

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

  1029. <h3>Parameters</h3>

  1030. <div class="subelement argument">

  1031. <h4>$pSheetName</h4>

  1032. <code>string</code><p>Name of the worksheet to check</p></div>

  1033. <h3>Returns</h3>

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

  1035. </div></div>

  1036. </div>

  1037. <a id="method__getExtensionOnly"></a><div class="element clickable method private method__getExtensionOnly" data-toggle="collapse" data-target=".method__getExtensionOnly .collapse">

  1038. <h2>return the extension of a filename.</h2>

  1039. <pre>_getExtensionOnly($ThePath) </pre>

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

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

  1042. <div class="long_description"><p>Internal use for a array_map callback (php&lt;5.3 don't like lambda function)</p></div>

  1043. <h3>Parameters</h3>

  1044. <div class="subelement argument"><h4>$ThePath</h4></div>

  1045. </div></div>

  1046. </div>

  1047. <h3>

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

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

  1050. <h2></h2>

  1051. <pre>$_activeSheetIndex : int</pre>

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

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

  1054. </div>

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

  1056. <h2></h2>

  1057. <pre>$_calculationEngine : <a href="../classes/PHPExcel_Calculation.html">\PHPExcel_Calculation</a></pre>

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

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

  1060. </div>

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

  1062. <h2></h2>

  1063. <pre>$_cellStyleXfCollection : <a href="PHPExcel.Style.html#%5CPHPExcel_Style">\PHPExcel_Style[]</a></pre>

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

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

  1066. </div>

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

  1068. <h2></h2>

  1069. <pre>$_cellXfCollection : <a href="PHPExcel.Style.html#%5CPHPExcel_Style">\PHPExcel_Style[]</a></pre>

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

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

  1072. </div>

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

  1074. <h2></h2>

  1075. <pre>$_cellXfSupervisor : <a href="../classes/PHPExcel_Style.html">\PHPExcel_Style</a></pre>

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

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

  1078. </div>

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

  1080. <h2></h2>

  1081. <pre>$_hasMacros : bool</pre>

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

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

  1084. </div>

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

  1086. <h2></h2>

  1087. <pre>$_macrosCertificate : \binary</pre>

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

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

  1090. </div>

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

  1092. <h2></h2>

  1093. <pre>$_macrosCode : \binary</pre>

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

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

  1096. </div>

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

  1098. <h2></h2>

  1099. <pre>$_namedRanges : <a href="PHPExcel.NamedRange.html#%5CPHPExcel_NamedRange">\PHPExcel_NamedRange[]</a></pre>

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

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

  1102. </div>

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

  1104. <h2></h2>

  1105. <pre>$_properties : <a href="../classes/PHPExcel_DocumentProperties.html">\PHPExcel_DocumentProperties</a></pre>

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

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

  1108. </div>

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

  1110. <h2></h2>

  1111. <pre>$_ribbonBinObjects : NULL | array</pre>

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

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

  1114. </div>

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

  1116. <h2></h2>

  1117. <pre>$_ribbonXMLData : NULL | string</pre>

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

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

  1120. </div>

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

  1122. <h2></h2>

  1123. <pre>$_security : <a href="../classes/PHPExcel_DocumentSecurity.html">\PHPExcel_DocumentSecurity</a></pre>

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

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

  1126. </div>

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

  1128. <h2></h2>

  1129. <pre>$_uniqueID : string</pre>

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

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

  1132. </div>

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

  1134. <h2></h2>

  1135. <pre>$_workSheetCollection : <a href="PHPExcel.Worksheet.html#%5CPHPExcel_Worksheet">\PHPExcel_Worksheet[]</a></pre>

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

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

  1138. </div>

  1139. </div>

  1140. </div>

  1141. </div>

  1142. </div>

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

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

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

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

  1147. </div>

  1148. </body>

  1149. </html>